fenge 0.1.0-beta.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -5
- package/README.md +6 -6
- package/package.json +5 -5
- package/tsconfig.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
# fenge
|
|
2
2
|
|
|
3
|
-
## 0.1.
|
|
3
|
+
## 0.1.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- @fenge/eslint-config@0.1.1
|
|
8
|
+
|
|
9
|
+
## 0.1.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
|
6
12
|
|
|
@@ -14,7 +20,7 @@
|
|
|
14
20
|
- Updated dependencies [67f298b]
|
|
15
21
|
- Updated dependencies [db5931d]
|
|
16
22
|
- Updated dependencies [b5b70e3]
|
|
17
|
-
- @fenge/tsconfig@0.1.0
|
|
18
|
-
- @fenge/types@0.1.0
|
|
19
|
-
- @fenge/prettier-config@0.1.0
|
|
20
|
-
- @fenge/eslint-config@0.1.0
|
|
23
|
+
- @fenge/tsconfig@0.1.0
|
|
24
|
+
- @fenge/types@0.1.0
|
|
25
|
+
- @fenge/prettier-config@0.1.0
|
|
26
|
+
- @fenge/eslint-config@0.1.0
|
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
<details>
|
|
24
24
|
<summary>简体中文</summary>
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
经过多年实践,我们发现,最影响现代 JavaScript 工程的代码质量和开发体验的主要有 3 个方面:
|
|
27
27
|
|
|
28
28
|
- **类型安全**:用于提前发现类型、拼写错误,例如对象方法是否正确调用、函数参数传递的类型是否符合函数体的期望等。
|
|
29
29
|
- **Formatting**:用于统一格式,提升代码可读性,减少代码冲突。主要关注例如缩进、换行、单/双引号、带/不带分号等问题。
|
|
@@ -56,7 +56,7 @@ Based on the philosophy outlined above, this tool offers the following features:
|
|
|
56
56
|
|
|
57
57
|
- 💪 **Enhanced Type Safety**: This tool provides the strictest `tsconfig` settings and type patches to bolster the type safety of TypeScript projects. It is also compatible with pure JavaScript projects.
|
|
58
58
|
- 💃 **Formatting**: This tool ensures code consistency across your codebase and minimizes merge conflicts by automatically formatting code. It additionally supports the sorting of imports and `package.json` files.
|
|
59
|
-
- 📏 **Linting**:
|
|
59
|
+
- 📏 **Linting**: This tool comes equipped with a comprehensive set of rules for static code analysis, which helps catch errors and prevent poor coding practices in JavaScript.
|
|
60
60
|
- 🪝 **Git Hooks**: After installation, committing code via Git triggers automatic formatting and linting checks. No additional package installations are required.
|
|
61
61
|
|
|
62
62
|
## Highlights
|
|
@@ -123,9 +123,9 @@ tsc -p ./tsconfig.build.json --noEmit
|
|
|
123
123
|
|
|
124
124
|
For more beat practices, please refer to [@fenge/tsconfig](https://www.npmjs.com/package/@fenge/tsconfig).
|
|
125
125
|
|
|
126
|
-
#### Import
|
|
126
|
+
#### Import type patch
|
|
127
127
|
|
|
128
|
-
Add a [triple-slash-directive](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) `/// <reference types="fenge/types" />` at the top of the ts file that serves as the entry point for your application or package. This will make the entire project more type-safe.
|
|
128
|
+
Add a [triple-slash-directive](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) `/// <reference types="fenge/types" />` at the top of the ts file that serves as the entry point for your application or package. This will make the entire project more type-safe. The built-in type patch `fenge/types` re-exports from [@fenge/types](https://www.npmjs.com/package/@fenge/types).
|
|
129
129
|
|
|
130
130
|
Application/Package Entry Point (eg: `src/main.ts` or `src/app.ts`)
|
|
131
131
|
|
|
@@ -189,7 +189,7 @@ export default {
|
|
|
189
189
|
};
|
|
190
190
|
```
|
|
191
191
|
|
|
192
|
-
Usually, we recommend reusing the built-in configurations rather than writing them from scratch.
|
|
192
|
+
Usually, we recommend reusing the built-in configurations rather than writing them from scratch. The built-in configurations re-export from [@fenge/prettier-config](https://www.npmjs.com/package/@fenge/prettier-config) and [@fenge/eslint-config](https://www.npmjs.com/package/@fenge/eslint-config).
|
|
193
193
|
|
|
194
194
|
```js
|
|
195
195
|
// @ts-check
|
|
@@ -231,7 +231,7 @@ You can even install and use other third-party eslint-config, like [@sxzz/eslint
|
|
|
231
231
|
|
|
232
232
|
### Set up Git hooks
|
|
233
233
|
|
|
234
|
-
Executing `fenge install` will write a `pre-commit` file to the `${PROJECT_ROOT}/.git/hooks` folder. After editing `package.json -> scripts -> prepare` script and executing it once, each commit (via Git) will trigger a code style check for the committed files.
|
|
234
|
+
Executing `fenge install` in the project root will write a `pre-commit` file to the `${PROJECT_ROOT}/.git/hooks` folder. After editing `package.json -> scripts -> prepare` script and executing it once, each commit (via Git) will trigger a code style check for the committed files.
|
|
235
235
|
|
|
236
236
|
```json
|
|
237
237
|
{
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fenge",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "A CLI tool for code quality",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"cli",
|
|
@@ -48,10 +48,10 @@
|
|
|
48
48
|
"lint-staged": "15.2.10",
|
|
49
49
|
"ora": "8.1.0",
|
|
50
50
|
"prettier": "3.3.3",
|
|
51
|
-
"@fenge/eslint-config": "0.1.
|
|
52
|
-
"@fenge/prettier-config": "0.1.0
|
|
53
|
-
"@fenge/tsconfig": "0.1.0
|
|
54
|
-
"@fenge/types": "0.1.0
|
|
51
|
+
"@fenge/eslint-config": "0.1.1",
|
|
52
|
+
"@fenge/prettier-config": "0.1.0",
|
|
53
|
+
"@fenge/tsconfig": "0.1.0",
|
|
54
|
+
"@fenge/types": "0.1.0",
|
|
55
55
|
"prettier-ignore": "0.1.3"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
package/tsconfig.json
CHANGED