my-typescript-library-starter - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

package.json

 {
   "name": "my-typescript-library-starter",
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "packageManager": "pnpm@8.15.3",
@@ -85,3 +85,3 @@ "description": "A boilerplate for starting a TypeScript library, equipped with Vitest + ESLint + Commitizen + Husky + Release-it and generating beautiful change-log with Changelogen",
   "lint-staged": {
-    "*.{js,cjs,ts,vue}": "eslint --fix"
+    "*.{js,cjs,ts,vue,yml}": "eslint --fix"
   },
@@ -93,2 +93,2 @@ "config": {
   }
-}
+}

README.md

 # my-typescript-library-starter
+A boilerplate for starting a TypeScript library with ease, equipped with:
+ - ESLint
+ - Commitizen
+ - Husky
+ - Release-it
+ - Changelogen
 
@@ -6,4 +12,27 @@ > **Note**:
 
+## ESLint & ESLint Configuration
+We use @antfu amazing eslint configuration. Js file `eslint.config.js` configures the `eslint`. It extends antfu's configuration but you can customize it. for example if you prefer to use double-quotations for string, change this file as:
+
+``` javascript
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  stylistic: {
+    quotes: 'double'
+  },
+})
+```
+## Conventional Commits & Husky Hooks
+we use `Commitizen` for conventinal commits. `husky` is used to enforce conventional commit messages with `commitlint`.
+
+## Test & Test Coverage
+`Vitest` is used for running tests and measure test coverage.
+
+## Release-it for Releasing
+We use `release-it` for version management and publish to anywhere (npm or github). We also use its hooks to execute any command we need to test, build, and publish our project.
+
+## Auto Changelog based on Conventional Commits
+We use `changelogen` to generate beautiful changelogs using Conventional Commits.
+
 ## License
-
 [MIT](./LICENSE) License

No alert changes

Improved metrics

Total package byte prevSize

5376

26.46%

Number of lines in readme file

38

322.22%

No dependency changes