contributing-generator - npm Package Compare versions

Comparing version 0.1.0 to 1.1.0

package.json

 {
   "name": "contributing-generator",
+  "description": "A generator for the CONTRIBUTING.md files and cie",
+  "keywords": [
+    "contributing",
+    "markdown",
+    "npm"
+  ],
+  "author": "Thibault Friedrich <[e-mail]>",
   "license": "MIT",
   "type": "module",
-  "version": "0.1.0",
-  "bin": "./dist/index.js",
+  "version": "1.1.0",
+  "bin": {
+    "contributing-generator": "./dist/cli.js"
+  },
   "scripts": {
@@ -11,2 +20,3 @@ "dev": "ts-node -T ./src/cli.ts",
     "test": "jest",
+    "lint": "eslint .",
     "format": "prettier --check ."
@@ -22,2 +32,7 @@ },
   "devDependencies": {
+    "@eslint/js": "^8.57.0",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^11.0.3",
+    "@semantic-release/release-notes-generator": "^12.1.0",
     "@tsconfig/node20": "^20.1.2",
@@ -27,8 +42,14 @@ "@tsconfig/strictest": "^2.0.3",
     "@types/node": "^20.11.24",
+    "@typescript-eslint/parser": "^7.1.1",
     "@vercel/ncc": "^0.38.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
+    "semantic-release": "^23.0.2",
     "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2"
+    "ts-node": "^10.9.2",
+    "typescript-eslint": "^7.1.1"
   }
 }

README.md

 # contributing-generator
 
-An interactive prompte to generate CONTRIBUTING.md, LICENSE, CODE_OF_CONDUCT.md, and README.md files for your project.
+An smart and interactive prompt to generate documentation in **CONTRIBUTING.md**, **LICENSE**, **CODE_OF_CONDUCT.md**, **package.json** and **README.md** files for your project.
 
+It gathers as maximum information as possible from your git configuration, github profile and package.json file to generate the files.
+
 ## Get Started
 
 ```bash
-npx contributing-generator
+$ npx contributing-generator
+
+? What do you want to generate? (Use arrow keys)
+❯ license
+  contributing
+  readme
+  code_of_conduct
+  pull_request_template
 ```
 
-## Contributing
+For example, it will detect the license if existing, the year, the organization name from github:
 
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
+```bash
+? What do you want to generate? license
+? Choose a license: MIT
+? Year: 2024
+? Organization: Thibault Friedrich
+? Path: (/Users/thibault/Code/productivity/contributing-generator)
+```
 
+> We suggest you to commit your changes before running the generator, as it will overwrite some files and you might want to revert some changes.
+
+Check the templates in the [templates](./templates) folder.
+
 ```bash
@@ -21,4 +40,8 @@ pnpm install # Install dependencies
 
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code practices and the process for submitting pull requests.
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

New alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 2 instances in 1 package

Fixed alerts

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

668899

increased by41.16%

Number of package files

84

increased by86.67%

Lines of code

4949

increased by17.75%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

47

increased by95.83%

Worsened metrics

Dev dependency count

20

increased by122.22%

Number of low license alerts

6

increased by50%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes