apolofx / lampone Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 332 KB

NodeJS CLI toolkit intended to automate common configurations and libraries in JavaScript projects

Shell 0.61% JavaScript 11.54% TypeScript 87.84%

lampone's People

Contributors

Stargazers

Watchers

lampone's Issues

Add TypeScript boilerplate

The boilerplate could offer the options below:
Before writing any code, consider using something like TSDX

Base Framework:
- Node
- React
- Vue
Add development watcher and hot reloading like ts-node-dev
Add basic tsconfig.json configuration based on project type

Add Jest boilerplate

This boilerplate should add basic Jest support and configuration to a Node based project
options:

TypeScript support

Create API folder to modularize tool's command interfaces

We could have an API folder which could contain all the needed vendors API methods abstracted into our own Lampone API to ease the script execution in the users command line.
Example:
Vendors cli:
prettier --write .
Lampone adapted api:

prettier.format() // executes exec("prettier --write .") on user's root dir.

make helper in order not to override edits made by npm scripts

lampone/lib/scripts.ts

Lines 15 to 20 in 9f34173

 //TODO make helper in order not to override edits made by npm scripts 

 const rawPackageJSON = fs.readFileSync(`package.json`); 

 const packageJSON = JSON.parse(rawPackageJSON.toString()); 

 packageJSON["scripts"]["prepare"] = "husky install"; 

 packageJSON["lint-staged"] = { 

 "**/*": "prettier --write --ignore-unknown",

This issue was generated by todo based on a `TODO` comment in `9f34173`. It's been assigned to @Apolofx because they committed the code.

check for husky and lint-staged already in package.json

lampone/lib/scripts.ts

Lines 17 to 20 in 8544beb

 //TODO check for husky and lint-staged already in package.json 

 //TODO make helper in order not to override edits made by npm scripts 

 const bufferedJSON = fs.readFileSync(`package.json`); 

 const packageJSON = JSON.parse(bufferedJSON.toString());

This issue was generated by todo based on a `TODO` comment in `8544beb`. It's been assigned to @Apolofx because they committed the code.

check if pre-commit .sh is already created to prevent duplicated npx scripts

lampone/lib/scripts.ts

Lines 12 to 15 in 4821b7b

 //TODO check if pre-commit .sh is already created to prevent duplicated npx scripts 

 execSync("npx husky add .husky/pre-commit 'npx lint-staged'", { 

 stdio: [0, 1, 2], 

 });

This issue was generated by todo based on a `TODO` comment in `4821b7b`. It's been assigned to @Apolofx because they committed the code.

add menu to choose between scripts

lampone/index.ts

Lines 7 to 11 in 8544beb

 //TODO add menu to choose between scripts 

 //if not script-specific flag in cli args is present 

 clear(); 

 console.log( 

 figlet.textSync("Lampone", {

This issue was generated by todo based on a `TODO` comment in `8544beb`. It's been assigned to @Apolofx because they committed the code.

Add Node CI workflow

Add github actions workflow to:

Test
Lint
Publish

put questions array on a separate file inquirer.ts

lampone/index.ts

Lines 9 to 14 in cf84596

 //TODO put questions array on a separate file inquirer.ts 

 initCLI(); 

 const args: Argv = minimist(process.argv.slice(2)); 

 debug(args);

This issue was generated by todo based on a `TODO` comment in `cf84596` when #13 was merged. cc @Apolofx.

Prevent prettier command to format every file

Current behaviour:

When selecting Prettier tool from the CLI menu, it formats all the current source code without asking first.

Expected behaviour:

We should give the user the option to format all code or just seek and check the files that need to be formated.

The approach for this should be to conditionally use the --write or --check flags in prettier command.
See Prettier Docs on this subjects.

Abstract npm/yarn commands into helper module

Implement some kind of module with a friendly interface that can handle both yarn and npm scripts with flags

Add Jest and basic Test Suit

https://itnext.io/testing-with-jest-in-typescript-cc1cd0095421

	//TODO make helper in order not to override edits made by npm scripts
	const rawPackageJSON = fs.readFileSync(`package.json`);
	const packageJSON = JSON.parse(rawPackageJSON.toString());
	packageJSON["scripts"]["prepare"] = "husky install";
	packageJSON["lint-staged"] = {
	"*/": "prettier --write --ignore-unknown",

	//TODO check for husky and lint-staged already in package.json
	//TODO make helper in order not to override edits made by npm scripts
	const bufferedJSON = fs.readFileSync(`package.json`);
	const packageJSON = JSON.parse(bufferedJSON.toString());

	//TODO check if pre-commit .sh is already created to prevent duplicated npx scripts
	execSync("npx husky add .husky/pre-commit 'npx lint-staged'", {
	stdio: [0, 1, 2],
	});

	//TODO add menu to choose between scripts
	//if not script-specific flag in cli args is present
	clear();
	console.log(
	figlet.textSync("Lampone", {

	//TODO put questions array on a separate file inquirer.ts

	initCLI();

	const args: Argv = minimist(process.argv.slice(2));
	debug(args);

apolofx / lampone Goto Github PK

lampone's People

Contributors

Stargazers

Watchers

lampone's Issues

This issue was generated by todo based on a TODO comment in 9f34173. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a TODO comment in 8544beb. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a TODO comment in 4821b7b. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a TODO comment in 8544beb. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a TODO comment in cf84596 when #13 was merged. cc @Apolofx.

Current behaviour:

Expected behaviour:

Recommend Projects

Recommend Topics

Recommend Org

Jobs

This issue was generated by todo based on a `TODO` comment in `9f34173`. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a `TODO` comment in `8544beb`. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a `TODO` comment in `4821b7b`. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a `TODO` comment in `8544beb`. It's been assigned to @Apolofx because they committed the code.

This issue was generated by todo based on a `TODO` comment in `cf84596` when #13 was merged. cc @Apolofx.