https://github.com/tiagoboeing/create-styleguide-cli
A CLI to automate style guide configs for JavaScript projects, this auto add ESLint and Prettier for work together.
https://github.com/tiagoboeing/create-styleguide-cli
cli eslint eslint-config javascript node npm npm-package prettier prettier-config prettier-eslint
Last synced: 3 months ago
JSON representation
A CLI to automate style guide configs for JavaScript projects, this auto add ESLint and Prettier for work together.
- Host: GitHub
- URL: https://github.com/tiagoboeing/create-styleguide-cli
- Owner: tiagoboeing
- License: mit
- Created: 2020-10-15T01:18:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-31T18:22:13.000Z (almost 5 years ago)
- Last Synced: 2025-06-26T13:55:20.020Z (3 months ago)
- Topics: cli, eslint, eslint-config, javascript, node, npm, npm-package, prettier, prettier-config, prettier-eslint
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@tiagoboeing/create-styleguide
- Size: 401 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Style Guide CLI
   
A CLI to add ESLint + Prettier and enforce a style guide based on `ESLint standard`. **This automatize dependencies install and Prettier + ESLint configs**, adding specific files for different frameworks/languages (in case of JS or TS).
## Framework/language support
| Framework / Language | Support? |
| ----------------------------------------- | -------- |
| Angular 2+ | ✅ Yes |
| JavaScript (Browser + Node) | ✅ Yes |
| React / Next.js (Typescript) | ✅ Yes |
| TypeScript (use Angular template for now) | Roadmap |
> Contribute sending a pull request or can be a sponsor
## SO support
| SO | Support? |
| ------- | ---------- |
| Linux | ✅ Yes |
| Windows | ✅ Yes |
| MacOS | Not tested |
> You can edit this README if test on MacOS. 😁
## Use
Before run, remove following files from your project root if exists:
- `.editorconfig`
- `.eslintignore`
- `.eslintrc.json`
- `.prettierrc`
Run the command on root of your project. (Same folder of `package.json`)
```bash
$ npm init @tiagoboeing/styleguide
# or
$ npx @tiagoboeing/create-styleguide
# or
$ npm i -g @tiagoboeing/create-styleguide
$ create-styleguide
# after run, select a option and be happy! 🎉
? What the type of your project?
❯ JavaScript
Angular 2+
React / Next.js (TypeScript)
```
> Before execute, do a backup or commit your files!
## Development
To run local exists two strategies:
1. Using directly `NPM`
```bash
# on root folder, run for register CLI on envs
$ npm link
# create any folder to run the CLI
$ mkdir test
$ cd test
# start a Node project to create a package.json
$ npm init -y
# and... run the CLI for apply magic 🚀
$ create-styleguide
```
2. Using VSCode automated tasks (`tasks.json` and `launch.json`)
Press F5 key to run or use Ctrl + Shift + D to access run side menu and select "Launch" on context menu to run the all predefined tasks.
On `.vscode/tasks.json` you can change the CLI args in:
```json
...
"args": [
"--project",
"javascript" <- here
],
```
## Defaults
> Same configs for all projects types
Prettier
```json
{
"$schema": "http://json.schemastore.org/prettierrc",
"semi": false,
"singleQuote": true,
"arrowParens": "avoid",
"trailingComma": "none",
"endOfLine": "auto",
"tabWidth": 2,
"printWidth": 95
}
```
.editorconfig
```conf
# Editor configuration, see https://editorconfig.org
root = true
[*]
indent_style = space
indent_size = 2
charset = utf-8
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
max_line_length = off
trim_trailing_whitespace = false
```