Merge pull request #39 from koonfoon/develop

Develop +semver: patch

Author: koonfoon

.github/workflows/master-pr-title-checker.yml

@@ -0,0 +1,26 @@
+# This action is to check if the PR title contain "+semver: major | minor | patch | skip"
+
+name: 'Commit Message Check'
+
+on:
+  pull_request:
+    branches:
+      - 'master'
+    types:
+      - opened
+      - edited
+      - reopened
+      - synchronize
+
+jobs:
+    check-pr-title:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Display PR title
+          run: echo The Title of your PR is ${{ github.event.pull_request.title }}
+          
+        - name: Check PR title
+          uses: Slashgear/[email protected]
+          with:
+            regexp: \+semver:\s?(major|minor|patch|skip)
+            helpMessage: "PR title must contain '+semver: major | minor | patch | skip'"

README.md

@@ -1,9 +1,11 @@
-# generator-vscode-typescript-jest [![NPM version][npm-image]][npm-url][![coverage](https://github.com/koonfoon/generator-vscode-typescript-jest/actions/workflows/node-jest-test.yml/badge.svg)](https://github.com/koonfoon/generator-vscode-typescript-jest/actions/workflows/node-jest-test.yml)
+# generator-vscode-typescript-jest [![npm version](https://badge.fury.io/js/generator-vscode-typescript-jest.svg)](https://badge.fury.io/js/generator-vscode-typescript-jest)[![coverage](https://github.com/koonfoon/generator-vscode-typescript-jest/actions/workflows/node-jest-test.yml/badge.svg)](https://github.com/koonfoon/generator-vscode-typescript-jest/actions/workflows/node-jest-test.yml)
 
 ## Description
 
 vscode with typescript and jest project generator. This package generate the project skeleton for visual studio code that use [typescript](https://www.typescriptlang.org/) as source code, and [jest](https://jestjs.io/) for unit test, [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) for linting and [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for prettier codes. This generator also compose with [generator-license](https://github.com/jozefizso/generator-license).
 
+For those who only need to setup eslint and prettier. Use the sub generator. (See instruction below)
+
 This generator will also setup [tsup](https://github.com/egoist/tsup), a tool for bundling codes into commonjs and esm at the same time.
 
 ## Installation
@@ -21,6 +23,15 @@ Then generate your new project:
 yo vscode-typescript-jest
 ```
 
+### Sub generator
+
+```bash
+yo vscode-typescript-jest:eslint-prettier
+```
+
+> **Note**
+> When using sub generator. If package.json already exist in the project, a warning message will be display. Giving you an warning that package.json is about to be overwritten, and asking user permission to proceed. But in reality, it does not overwrite the WHOLE package.json file, just inserting the dev dependencies for eslint and prettier. User can enter "d" option to see what will be inserted to the package.json before enter "y" option. 
+
 > **Note**  
 > You should run `npx npm-check-updates` check and update the dependencies, as newer version may had released since the publication of this generator.
 
@@ -66,6 +77,3 @@ yo vscode-typescript-jest
 ## License
 
 MIT © [koonfoon]()
-
-[npm-image]: https://badge.fury.io/js/generator-vscode-typescript-jest.svg
-[npm-url]: https://npmjs.org/package/generator-vscode-typescript-jest

__tests__/eslint-prettier.js

@@ -0,0 +1,14 @@
+"use strict";
+const path = require("path");
+const assert = require("yeoman-assert");
+const helpers = require("yeoman-test");
+
+describe("generator-vscode-typescript-jest:eslint-prettier", () => {
+  beforeAll(() => {
+    return helpers.run(path.join(__dirname, "../generators/eslint-prettier"));
+  });
+
+  it("creates files", () => {
+    assert.file([".eslintrc.json", ".prettierrc.json", "package.json"]);
+  });
+});

generators/eslint-prettier/index.js

@@ -0,0 +1,48 @@
+"use strict";
+const Generator = require("yeoman-generator");
+const chalk = require("chalk");
+const yosay = require("yosay");
+
+module.exports = class extends Generator {
+  prompting() {
+    // Have Yeoman greet the user.
+    this.log(
+      yosay(
+        `Welcome to the lovely ${chalk.red(
+          "generator-vscode-typescript-jest"
+        )} generator!`
+      )
+    );
+
+    const prompts = [];
+
+    return this.prompt(prompts).then(props => {
+      // To access props later use this.props.someAnswer;
+      this.props = props;
+    });
+  }
+
+  writing() {
+    this.fs.copy(
+      this.templatePath(".eslintrc.temp.json"),
+      this.destinationPath(".eslintrc.json")
+    );
+    this.fs.copy(
+      this.templatePath(".prettierrc.temp.json"),
+      this.destinationPath(".prettierrc.json")
+    );
+
+    const pkgJson = {
+      devDependencies: {
+        "@typescript-eslint/eslint-plugin": "^5.38.0",
+        "@typescript-eslint/parser": "^5.38.0",
+        eslint: "^8.23.1",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^4.2.1",
+        prettier: "^2.7.1"
+      }
+    };
+
+    this.fs.extendJSON(this.destinationPath("package.json"), pkgJson);
+  }
+};

generators/eslint-prettier/templates/.eslintrc.temp.json

@@ -0,0 +1,19 @@
+{
+  "env": {
+    "commonjs": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    //"eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "rules": {}
+}

generators/eslint-prettier/templates/.prettierrc.temp.json

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120,
+  "tabWidth": 4,
+  "endOfLine": "auto"
+}