Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taoyage/yg-configs
CLI toolbox for common scripts for front-end projects
https://github.com/taoyage/yg-configs
babel commitlint eslint lintstaged postcss stylelint swc swc-loader
Last synced: about 1 month ago
JSON representation
CLI toolbox for common scripts for front-end projects
- Host: GitHub
- URL: https://github.com/taoyage/yg-configs
- Owner: taoyage
- License: mit
- Created: 2022-04-18T11:22:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T10:39:31.000Z (almost 2 years ago)
- Last Synced: 2024-10-08T22:46:04.247Z (about 1 month ago)
- Topics: babel, commitlint, eslint, lintstaged, postcss, stylelint, swc, swc-loader
- Language: JavaScript
- Homepage:
- Size: 869 KB
- Stars: 276
- Watchers: 31
- Forks: 45
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# yg-configs 🛠📦
 
CLI toolbox for common scripts for my front-end projects
---
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [config prettier](#config-prettier)
- [config eslint](#config-eslint)
- [config commitlint](#config-commitlint)
- [config lintstaged](#config-lintstaged)
- [config stylelint](#config-stylelint)
- [config postcss](#config-postcss)
- [config swc](#config-swc)
- [config babel](#config-babel)
- [example](https://github.com/taoyage/yg-configs/tree/master/example)
## Installation
```javascript
$ npm install @taoyage/configs --save-dev
or
$ pnpm install @taoyage/configs -D
```
## Usage
This can be a very helpful way to make editor integration work for tools like ESLint，babel，prettier，commitlint which require project-based configuration to be present to work.
### config prettier
if we were to do this for prettier, you could create an .prettierrc.js with the contents of
```javascript
module.exports = require('@taoyage/configs/prettier');
```
### config eslint
if we were to do this for eslint of typescript react project, you could create an .eslintrc.js with the contents of
```javascript
module.exports = require('@taoyage/configs/eslint-ts');
```
create tsconfig.json with the contents of
```json
{
"extends": "@taoyage/configs/shared-tsconfig",
"compilerOptions": {},
"exclude": [],
"include": []
}
```
### config commitlint
if were to do this for commitlint, you could create an .commitlintrc.js with the contents of
```javascript
module.exports = require('@taoyage/configs/commitlint');
```
### config lintstaged
if were to do this for lintstaged, you could create an .lintstagedrc.js with the contents of
```javascript
module.exports = require('@taoyage/configs/lintstaged');
```
### config stylelint
if were to do this for stylelint, you could create an .stylelintrc.js with the contents of
```javascript
module.exports = require('@taoyage/configs/stylelint');
```
### config postcss
if were to do this for postcss, you could create an postcss.config.js with the contents of
```javascript
module.exports = require('@sk/configs/postcss');
```
### config swc
if were to do swc-loader to webpack configure，you could import this swc configuration，
this configuration suport typescript program. example of
```javascript
import swcOptions from '@taoyage/configs/swc-ts';
module: {
rules: [
{
test: /\.ts?x$/,
use: {
loader: 'swc-loader',
options: swcOptions(rootPath, { isDev: false, override: {} }),
},
},
],
},
```
| params | description | type |
| -------- | ---------------------------- | ------ |
| rootPath | tsconfig.json file path | string |
| isDev | current is dev or production | bool |
| override | swc compilation config | object |
### config babel
if were todo babel-loader to webpack configure to react, you could create an .babelrc.js with content of
```javascript
module.exports = {
presets: [['@taoyage/configs/babel']],
};
```
### TODO
- [x] eslint config
- [x] tsconfig
- [x] prettier
- [x] commitlint config
- [x] lintstage config
- [x] stylelint config
- [x] swc config
- [x] babel config
- [x] browserslist