Luctst-cli NPM

Content

Features ✨

Eslint.
Prettier.
Ava.
Editor config.
Continue integration with TravisCi
Copy this structure
Publish new version to npm with github action, need to add NPM_TOKEN secret variable in repo config.
Create a new tag with git and github action every time you push on master, need to add TOKEN_TAG secret variable in repo config.
Works for ECMAScript module

├── .github/
│ ├── workflows/
│ │ ├── publish.yml
│	├── ISSUE_TEMPLATE/
│	│	├── bug_report.md
│	│	├── feature_request.md
│	├── CODE_OF_CONDUCT.md
│	├── CONTRIBUTING.md
│	├── LICENSE
│	├── pull_request_template.md
├── lib/
│	├── main.js
├── test/
│	├── test.js
├── .editorconfig
├── .estlintrc.json
├── .gitattributes
├── .gitignore
├── .prettierignore
├── .prettierrc.json
├── package-lock.json
├── package.json
├── README.md

Install 🐙

npm install luctst-cli

Usage 💡

npx luctst-cli [command] [options]

Exemples 🖍

Default path

npx luctst-cli start

Create structure at the root of your nodejs process.

Custom path

├── test

npx luctst-cli start --path=test/

Create project inside the test folder.

Documentation 📄

Commands availables:

start, start the process to create your project.

Flags:

--version -v, show the package version.
--help -h, display all commands and flags availables.
--path -p, custom path where the project must be created.
--gitignore, The languages to use in your .gitignore file.
--name -n, Your name for LICENCE file.
--github-user, Your github username.
--project-name, The name of your project.
--description, -d, Little description of your project.

Scripts:

Those scripts are runnables once the process is done:

test, Test all files in test folder with Ava.
test:watch, Watch and test all files in test folder with Ava.
lint, Lint all files with prettier and eslint in lib folder.
lint:watch, Watch and lint all files with prettier and eslint in lib folder.
lint:fix, Fix some errors and warnings automatically.