Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xucongli1989/x-code-inspect
This is a package for checking JavaScript projects. You only need to install this package to use detection tools such as ESLint. Most importantly, you don't need to do extra ESLint configuration, just use the built-in default configuration.
https://github.com/xucongli1989/x-code-inspect
checker code eslint format inspect javascript
Last synced: about 1 month ago
JSON representation
This is a package for checking JavaScript projects. You only need to install this package to use detection tools such as ESLint. Most importantly, you don't need to do extra ESLint configuration, just use the built-in default configuration.
- Host: GitHub
- URL: https://github.com/xucongli1989/x-code-inspect
- Owner: xucongli1989
- License: gpl-3.0
- Created: 2020-11-05T13:59:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T02:09:40.000Z (4 months ago)
- Last Synced: 2024-11-21T11:38:35.359Z (about 2 months ago)
- Topics: checker, code, eslint, format, inspect, javascript
- Language: TypeScript
- Homepage:
- Size: 38 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
This is a package for checking JavaScript projects. You only need to install this package to use detection tools such as ESLint. Most importantly, you don't need to do extra ESLint configuration, just use the built-in default configuration.
# Why use it
- You don't set up common code checking tools for every project
- Keep project style the same
# Usage
- Open your project.
- Remove the configuration files about `ESLint` and `Prettier` from project, because you no longer need them and this tool will creates them automatically.
- `npm i --save-dev --save-exact x-code-inspect@latest`
- And copy these dependencies to `devDependencies`
```javascript
"@typescript-eslint/eslint-plugin": "4.8.2",
"@typescript-eslint/parser": "4.8.2",
"babel-eslint": "10.1.0",
"eslint": "7.14.0",
"eslint-config-airbnb": "18.2.1",
"eslint-config-airbnb-typescript": "12.0.0",
"eslint-plugin-import": "2.22.1",
"eslint-plugin-jsx-a11y": "6.4.1",
"eslint-plugin-react": "7.21.5",
"eslint-plugin-react-hooks": "4.2.0",
"prettier": "2.2.0",
"typescript": "4.1.2",
"x-package-version-strict-check": "1.7.0"
```
- And add a script
```javascript
"check":"x-code-inspect"
```
- `npm i`
- `npm run check`
# Preview
# Environment
- Node.js >= 10.13.0
# Built-in Inspectors
### project-basic
- File `package.json` must include: `script.start`, `script.dist`
- The project must contains directory: `src`, `dist`, `doc`
### x-package-version-strict-check
- [Home Page](https://github.com/xucongli1989/x-package-version-strict-check)
### ESLint
- [Home Page](https://eslint.org/)
- [VS Code Plug-in](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint#review-details)
**Extra plug-ins:** `react`
### Prettier
- [Home Page](https://prettier.io/docs/en/index.html)
- [VS Code Plug-in](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode#review-details)
### Type Check
Via TypeScript
# CLI Options
##### -V, --version
output the version number
##### --debug
Run as debug. (default: false)
##### --path
Project's path that you want to check. (default: "./")
##### --check-dir
Specify a directory to be scanned by code (e.g. by plug-ins such as ESLint), the default is root value of `--path`. (multiple are separated by `,`). (default: "")
##### --ignore-check-dir
Specify a directory to be no scanned by code (e.g. by plug-ins such as ESLint), (multiple are separated by `,`). (default: "")
##### --eslint-global
Define global variate, see ESLint's doc. (default: "")
##### -h, --help
output usage information
# Change Log
[CHANGELOG.md](CHANGELOG.md)