@common-stack/generate-plugin 5.0.5-alpha.9 → 6.0.1-alpha.0

package/lib/generators/add-fullstack/files/README.md

@@ -0,0 +1,50 @@
+# Full Stack Packages
+
+*Fullstack packages to develop and test end to end; to use as packages or work independently.*
+
+Purpose: 
+---
+The idea is to create modules for each package so it can work independently as well as integrated to another project as packages. 
+
+## Screenshot
+![screencast](./ScreenShot.png)
+
+
+Useful commands:
+---
+|command|Description|
+|--------------------------|-----------|    
+|`lerna clean`|                 - removes the node_modules directory from all packages. |
+|`npm start`|       - starts the web server and backend server. Or Use `yarn zen:watch`|
+|`yarn zen:watch`|         - starts the web server and backend server in watch mode.|
+|`yarn zen:watch:debug`|    - starts the web server and backend server in debug and watch mode.|
+|`yarn watch`|               - build the packages in watchmode (Useful for development)|
+|`yarn lerna`|               - install external dependencies at the repo root so they're |`lable to all packages.|
+|`yarn build`|               - build all the packages|
+|`yarn install`|                - runs `lerna` and `build`|
+|`lerna publish`|               - publishes packages in the current Lerna project. |
+
+Files explained:
+---    
+It uses `lerna.json` for creating the packages structure. Under packages you can create different modules based on its usage. For example:
+
+     packages                    - Has the packages to organize the codebase into multi-package repositories.
+         sample-core             - Core interfaces of the packages which can be shared between server and client.
+         sample-platform/server      - Core platform interfaces and its implementation code for Server.   
+         sample-platform/browser     - Core platform browser State related code which consists of Redux, Graphql Gql and UI Components.
+         sample-platform/react-shared-components     - React pure components and containers are defined. 
+     packages-modules            - Has the server and browser side packages designed for a specific module feature.
+     servers                     - Has the servers to organize the codebase into multi-package repositories.
+         frontend-server         - Frontend Client Server. This is useful to show demo of this package.
+         backend-server          - Backend apollo server. 
+    
+
+## [Click here for Project Setup](docs/development/CodeContribution/Project_Setup.md)
+
+In Order to get started with the development you need to go through the 
+documentation first
+
+- [Getting Started with lerna](./docs/development/CodeContribution/lerna-build-tools.md)
+- [Running the servers](./docs/development/CodeContribution/How_to_Run_Various_Options.md)
+- [Dos and Dont](./docs/development/CodeContribution/DoAndDont.md)
+

package/lib/generators/add-fullstack/files/babel.config.js

@@ -0,0 +1,24 @@
+module.exports = {
+    compact: false,
+    presets: [
+        '@babel/preset-typescript',
+        '@babel/preset-react',
+        ['@babel/preset-env', { modules: 'commonjs', loose: true }],
+    ],
+    plugins: [
+        '@babel/plugin-transform-modules-commonjs',
+        '@babel/plugin-transform-destructuring',
+        '@babel/plugin-transform-for-of',
+        '@babel/plugin-transform-regenerator',
+        '@babel/plugin-transform-runtime',
+        '@babel/plugin-syntax-dynamic-import',
+        '@babel/plugin-proposal-class-properties',
+        ['@babel/plugin-proposal-decorators', { legacy: true }],
+        '@babel/plugin-proposal-object-rest-spread',
+    ],
+    env: {
+        production: {
+            compact: true,
+        },
+    },
+};

package/lib/generators/add-fullstack/files/build.config.js

@@ -0,0 +1,32 @@
+/* eslint-disable no-nested-ternary */
+/* eslint-disable no-underscore-dangle */
+// process.env.ENV_FILE !== null && require('dotenv').config({ path: process.env.ENV_FILE });
+
+const __API_SERVER_PORT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).port : 8080;
+const __WEB_SERVER_PORT__ = process.env.LOCAL_BACKEND_URL ? new URL(process.env.LOCAL_BACKEND_URL).port : 3000;
+const __WEB_DEV_SERVER_PORT__ =
+    process.env.SSR === 'true' ? 3010 : process.env.CLIENT_URL ? new URL(process.env.CLIENT_URL).port : 3000;
+const __SERVER_PROTOCOL__ = 'http';
+const __LOCAL_SERVER_HOST__ = 'localhost';
+const __GRAPHQL_ENDPOINT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).pathname : '/graphql';
+const config = {
+    __SERVER__: false,
+    __CLIENT__: true,
+    __SSR_BACKEND__: process.env.SSR_BACKEND,
+    __SSR__: process.env.SSR === 'true',
+    __DEBUGGING__: false,
+    __TEST__: false,
+    __WEB_DEV_SERVER_PORT__,
+    __GRAPHQL_ENDPOINT__,
+    __LOCAL_SERVER_HOST__,
+    __API_SERVER_PORT__,
+    __API_URL__:
+        process.env.API_URL ||
+        `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__API_SERVER_PORT__}${__GRAPHQL_ENDPOINT__}`,
+    __WEBSITE_URL__:
+        process.env.WEBSITE_URL || `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__WEB_DEV_SERVER_PORT__}`,
+    __BACKEND_URL__:
+        process.env.LOCAL_BACKEND_URL || `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__WEB_SERVER_PORT__}`,
+};
+
+module.exports = config;

package/lib/generators/add-fullstack/files/build.config.mjs

@@ -0,0 +1,37 @@
+/* eslint-disable no-nested-ternary */
+/* eslint-disable no-underscore-dangle */
+import { config as dotenvConfig } from 'dotenv-esm';
+
+if (process.env.ENV_FILE !== null) {
+    dotenvConfig({ path: process.env.ENV_FILE });
+}
+
+const __API_SERVER_PORT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).port : 8080;
+const __WEB_SERVER_PORT__ = process.env.LOCAL_BACKEND_URL ? new URL(process.env.LOCAL_BACKEND_URL).port : 3000;
+const __WEB_DEV_SERVER_PORT__ =
+    process.env.SSR === 'true' ? 3010 : process.env.CLIENT_URL ? new URL(process.env.CLIENT_URL).port : 3000;
+const __SERVER_PROTOCOL__ = 'http';
+const __LOCAL_SERVER_HOST__ = 'localhost';
+const __GRAPHQL_ENDPOINT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).pathname : '/graphql';
+
+const config = {
+    __SERVER__: false,
+    __CLIENT__: true,
+    __SSR_BACKEND__: process.env.SSR_BACKEND,
+    __SSR__: process.env.SSR === 'true',
+    __DEBUGGING__: false,
+    __TEST__: false,
+    __WEB_DEV_SERVER_PORT__,
+    __GRAPHQL_ENDPOINT__,
+    __LOCAL_SERVER_HOST__,
+    __API_SERVER_PORT__,
+    __API_URL__:
+        process.env.API_URL ||
+        `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__API_SERVER_PORT__}${__GRAPHQL_ENDPOINT__}`,
+    __WEBSITE_URL__:
+        process.env.WEBSITE_URL || `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__WEB_DEV_SERVER_PORT__}`,
+    __BACKEND_URL__:
+        process.env.LOCAL_BACKEND_URL || `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__WEB_SERVER_PORT__}`,
+};
+
+export default config;

package/lib/generators/add-fullstack/files/codegen.yml

@@ -0,0 +1,47 @@
+overwrite: true
+schema: "./servers/backend-server/generated-schema.graphql"
+generates:
+  typings/graphql.d.ts:
+    schema: 
+      - "packages-modules/counter/browser/src/apollo-server-n-client/**/*.graphql"
+      - packages-modules/counter/server/src/schema/**/*.graphql
+    documents: "packages-modules/counter/browser/src/**/*.gql"
+    plugins:
+      - typescript-graphql-files-modules
+  packages-modules/counter/browser/src/generated-models.ts:
+    schema: 
+      - "packages-modules/counter/browser/src/apollo-server-n-client/**/*.graphql"
+      - packages-modules/counter/server/src/schema/**/*.graphql
+    documents: "packages-modules/counter/browser/src/**/*.gql"
+    config:
+        noNamespaces: true
+        withMutationFn: false
+        withHOC: false
+        withComponent: false
+        noGraphQLTag: true
+    plugins:
+      - add:
+          content: /* tslint:disable */
+      - typescript
+      - typescript-operations
+      - typescript-resolvers
+      - typescript-react-apollo
+  packages-modules/counter/browser/src/apollo-server-n-client/generated-model.tsx:
+    schema: 
+      - "packages-modules/counter/browser/src/apollo-server-n-client/**/*.graphql"
+      - packages-modules/counter/server/src/schema/**/*.graphql
+    documents: "packages-modules/counter/browser/src/**/*.gql"
+    config:
+      withMutationFn: false
+      withHOC: false
+      withComponent: false 
+      withHooks: true
+      noGraphQLTag: true
+    preset: import-types-preset
+    presetConfig:
+      typesPath: "../generated-models"
+      importTypesNamespace: SchemaTypes
+    plugins:
+      - add:
+          content: /* tslint:disable */
+      - typescript-react-apollo

package/lib/generators/add-fullstack/files/commitlint.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    rules: {
+        'header-max-length': [0, 'always', 100], // corresponding to maxHeaderWidth of commitizen
+    },
+};

package/lib/generators/add-fullstack/files/config/development/dev.env.sample

@@ -0,0 +1,21 @@
+#  
+# Create `dev.env` file and load following required values
+#  
+# Build-time Variables
+BUILD_MODULE_TO_INCLUDE=@sample-stack/counter-module-browser|@sample-stack/assets|@sample-stack/platform-browser
+
+
+NATS_URL=nats://localhost:4222/
+NATS_USER=test
+NATS_PW=test
+GRAPHQL_URL=http://localhost:8080/graphql
+CLIENT_URL=http://localhost:3000
+ZIPKIN_URL=test
+ZIPKIN_PORT=test
+LOG_LEVEL=trace
+MONGO_URL=mongodb://localhost:27017/sample-stack
+REDIS_CLUSTER_URL='[{"port":6379,"host":"localhost"}]'
+REDIS_URL=redis://localhost:6379
+REDIS_CLUSTER_ENABLED=false
+REDIS_SENTINEL_ENABLED=false
+BACKEND_URL=http://localhost:8080

package/lib/generators/add-fullstack/files/config/development/settings.json

@@ -0,0 +1,9 @@
+{
+  "database": {
+    "client": "sqlite3",
+    "connection": {
+      "filename": "dev-db.sqlite3"
+    },
+    "useNullAsDefault": true
+  }
+}

package/lib/generators/add-fullstack/files/config/staging/docker-staging.env.sample

@@ -0,0 +1,26 @@
+###
+### To connect from docker to localhost, if you are using a Mac host, you can use -
+#
+# HOSTNAME= docker.for.mac.host.internal
+# Or
+#
+# HOSTNAME = docker.for.mac.localhost
+###docker.for.mac.localhost
+
+NATS_URL=nats://docker.for.mac.localhost:4222/
+NATS_USER=test
+NATS_PW=test
+GRAPHQL_URL=http://docker.for.mac.localhost:8080/graphql
+LOCAL_GRAPHQL_URL=http://docker.for.mac.localhost:8080/graphql 
+CLIENT_URL=http://localhost:3010
+ZIPKIN_URL=test
+ZIPKIN_PORT=test
+LOG_LEVEL=trace
+MONGO_URL=mongodb://docker.for.mac.localhost:27017/sample-stack
+REDIS_CLUSTER_URL='[{"port":6379,"host":"docker.for.mac.localhost"}]'
+REDIS_URL=redis://docker.for.mac.localhost:6379
+REDIS_CLUSTER_ENABLED=false
+REDIS_SENTINEL_ENABLED=false
+BACKEND_URL=http://localhost:8080
+CONNECTION_ID=v1
+LOCAL_BACKEND_URL=http://localhost:3010

package/lib/generators/add-fullstack/files/config/staging/staging.env.sample

@@ -0,0 +1,20 @@
+#  
+# Create `dev.env` file and load following required values
+#  
+NATS_URL=nats://localhost:4222/
+NATS_USER=test
+NATS_PW=test
+GRAPHQL_URL=http://localhost:8080/graphql
+LOCAL_GRAPHQL_URL=http://localhost:8080/graphql 
+CLIENT_URL=http://localhost:3011
+ZIPKIN_URL=test
+ZIPKIN_PORT=test
+LOG_LEVEL=trace
+MONGO_URL=mongodb://localhost:27017/sample-stack
+REDIS_CLUSTER_URL='[{"port":6379,"host":"localhost"}]'
+REDIS_URL=redis://localhost:6379
+REDIS_CLUSTER_ENABLED=false
+REDIS_SENTINEL_ENABLED=false
+BACKEND_URL=http://localhost:8080
+CONNECTION_ID=v1
+LOCAL_BACKEND_URL=http://localhost:3000

package/lib/generators/add-fullstack/files/config/test/test.env.sample

@@ -0,0 +1,9 @@
+#  
+# Create `test.env` file and load following required values
+#  
+MONGO_URL=mongodb://localhost:27017/sample-test
+DB_HOST=localhost
+DB_USER=mysql
+DB_PASSWORD=
+DB_SOCKET_PATH=
+DB_DATABASE=test

package/lib/generators/add-fullstack/files/docs/Moleculer.md

@@ -0,0 +1,10 @@
+
+
+Connecting to moleculer
+---
+
+moleculer connect --ns default
+
+
+References:
+https://moleculer.services/docs/0.14/moleculer-cli.html

package/lib/generators/add-fullstack/files/docs/References.md

@@ -0,0 +1,13 @@
+
+
+
+Hot Reload in Apollo Server 2
+--
+https://github.com/apollographql/apollo-server/issues/1275
+
+
+To update apollo-server
+====
+https://github.com/uzh-bf/klicker-uzh/blob/927512043e8b978c5874bb524eac5c5ff321e28b/apps/backend/src/app.js
+https://github.com/heypoom/eventkit/tree/165eb23dc8f3529b46f2cd1f187e4c592d8c9767
+https://github.com/cerino-ligutom/GraphQL-Starter/blob/master/src/graphql/index.ts

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/Adding_New_Modules.md

@@ -0,0 +1,84 @@
+# Adding Modules with FullStack Pro Kit
+
+In this guide, we explain how you can add new modules with FullStack-pro Kit.
+
+## Table of Contents
+
+* [Add New Modules](#installing-and-importing-dependencies)
+
+
+## Add New Modules
+
+Adding new modules, usually goes under `packages-modules` folder. For example to create counter module, you create
+
+1. From root directory, create following folders by running the commands (in unix).
+    ```
+    mkdir -p packages-modules/counter/browser/src
+    mkdir -p packages-modules/counter/servers/src
+
+    touch packages-modules/counter/browser/src/package.json
+    touch packages-modules/counter/servers/src/package.json
+    ```
+
+2. Copy following files from the existing modules,
+
+    From one of the existing moudles, copy the following files into the new module. Make sure the browser's module are copied from another existing browsers location and similarly for server's module.
+
+    - webpack.config.js
+    - tsconfig.json
+
+
+3. Copy the content of the package.json for both browser and server from the existing modules and change the `name` in the package.json to the specific name of the module you want to create. Please make sure to keep the namespace of the module uniform, if the existing module have `@sample-stack`, your new browser module's `package.json` name would be `@sample-stack/counter-browser`, similarly for server module will have `@sample-stack/counter-server`.
+
+    ```json
+    {
+        "name": "@sample-stack/counter-module-browser",
+        "version": "0.0.1",
+        .....
+        "publishConfig": {
+            "access": "public"
+        },
+        .....
+
+        "dependencies": {
+            "@sample-stack/platform-browser": "link:../../../packages/sample-platform/browser",
+        },
+        "peerDependencies": {
+            "@common-stack/client-react": ">=0.0.229",
+            "@common-stack/core": ">=0.0.229",
+            "antd": "^3.26.4"
+        }
+    }
+    ```
+    Add any additional dependencies that this module needed.
+
+4. Then, to use the new module add to `servers` and main `package.json`
+
+    a. In root `package.json` file add the new module where you have existing modules
+    ```json
+    "dependencies": {
+        .....
+        "@sample-stack/counter-module-browser": "link:packages-modules/counter/browser",
+        "@sample-stack/counter-module-server": "link:packages-modules/counter/server",
+        ....
+    }
+    ``` 
+    b. In frontend server `servers/frontend-server` add the browser module with relative path.
+    ```json
+    "dependencies": {
+        .....
+        "@sample-stack/counter-module-browser": "link:../../packages-modules/counter/browser",
+    }
+    ```
+    c. In backend servers `servers/backend-server` add the server module with relative path.
+    ```json
+    "dependencies": {
+        ....
+        "@sample-stack/counter-module-server": "link:../../packages-modules/counter/server",
+        ....
+    }
+    ```
+
+Notes:
+
+- You may have to rerun `yarn watch` to pickup new modules

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/Desktop_Setup.md

@@ -0,0 +1,12 @@
+
+# Follow steps to [install project](./Project_Setup.md)
+
+### Start Desktop application
+
+Before to start desktop application, make sure to start the backend server of the web application first. 
+
+`lerna exec --scope=*backend-server yarn watch`
+
+And then start desktop application. 
+
+`lerna exec --scope=*desktop yarn watch`

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/DoAndDont.md

@@ -0,0 +1,35 @@
+
+
+
+Don't do it...
+---
+1. `yarn <package>`
+
+    Do not install dependencies as `yarn <package dependency>`.
+    We use `lerna` and the way it works for the project is by installing `dependencies` to the `packages` or `servers` that requires it. In most cases,
+    you can just add the package to frontend or backend by running following
+
+    > to add to the frontend server so browser gets it
+
+   `lerna add --scope=*fronted-server <package>`
+
+
+    > to add to the backend server for nodejs to use it
+
+   `lerna add --scope=*backend-server <package>`
+
+    If a dependency is just needed by one package, you can add to that package's package.json file
+
+   `lerna add --scope=<package name> <package>`
+
+   Ideally, root `package.json` should have all the `devDependencies` of the project while `packages` & `servers` file references should be under `dependencies` section as shown [here](https://github.com/cdmbase/fullstack-pro/blob/master/package.json#L67-L78).
+
+   Sometimes we may need to `pin` a package as other dependencies can bring some older versions of the package we want to add. In that case we can pin the required package version by adding to the `pacakge.json`. But make sure you don't have different version of the package in `servers` or `packages` otherwise a duplciate package will be added to its `nodemodules`.
+
+Do
+---
+1. Each package version should be uniform across the repository
+
+    Before adding a `<package dependency>`, see if the package of different version exist. If it exist then update that version to the required version.
+
+2. You can edit one of the `packages` or `servers`'s `package.json` file directly to add a `dependencies` and then run `yarn lerna` to install them. This is a easy way to install a known version by adding to the target `pacakage.json` file.

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/GitHooks.md

@@ -0,0 +1,3 @@
+### Git Hooks
+
+`Husky` executes `lint-staged` and `commitlint` by git hooks. `lint-staged` makes sure staged files are to be formatted before committed. Refer to `package.json` for details.

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/HowToContribute.md

@@ -0,0 +1,14 @@
+
+How to contribute as a developer?
+--
+
+1. Once you setup the project, switch to `develop` branch. 
+2. Create a new branch using `develop` branch as source based on the issue you working. 
+3. Update changes to that branch and create a PR agains `develop` branch. 
+4. As soon as PR is created, we have a build process that runs in the background to check whether it is successful or failed.
+5. If it successfull you will see a green check otherwise a red cross. When you notice it has red cross then run `yarn build` locally and fix any issues and submit the commit again to check it's updated status.
+
+
+
+Note: `master` branch is read-only branch and we don't want to merge anything to it other than that from `develop` branch. So please avoid creating PRs agains master branch. 
+

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/How_to_Run_Various_Options.md

@@ -0,0 +1,95 @@
+## SETUP and INSTALL
+### To Install the project and build all packages
+
+`yarn bootstrap`
+
+### To clean install the project of already installed.
+
+If you need to do a clean the existing node_modules and take latest changes from the remote head
+
+`yarn clean:install`
+
+## LINTING
+### To check linting
+
+`yarn lint <relative folder>`
+
+### To check and auto fix linting
+
+`yarn format <relative folder>`
+
+## PACKAGES COMMANDS
+### To run build all packages
+
+`yarn build`
+
+### To run all packages in watch mode
+
+`yarn watch`
+
+Note: It only run `packages` and `packages-modules` only in watch mode. Servers should be run seperately.
+
+Also check out `yarn watch-packages` to run watch on required packages. 
+
+### To run build with watch for dependent packages
+
+For auto reloading changes into the server to be productive during development.
+
+```
+yarn watch-packages
+```
+
+If you also need to watch along with it, you can as many scopes as required like below. 
+
+```
+yarn watch-packages -- --scope=@sample-stack/counter-module* --scope=@packageb
+```
+
+## TO START SERVERS
+### To run a individual package in watch mode
+
+`lerna exec --scope=<package name> yarn watch`
+
+More details on how to use [lerna exec](https://github.com/lerna/lerna/tree/master/commands/exec#options)
+
+
+To run any command on a package <package_name>
+
+`lerna exec --scope=<package_name> <command>`
+
+
+### How to Start Backend and Frontend seperately.
+
+To start the frontend-server
+
+`lerna exec --scope=*frontend-server yarn watch`
+
+To just start the backend-server
+
+`lerna exec --scope=*backend-server yarn watch`
+
+### To run both Frontend and Backend Server
+
+`yarn start`
+
+### To run both Frontend and Backend Server but start frontend in SSR Mode
+
+`yarn start:envSSR`
+
+
+### To run Frontend with production build in development
+
+build the package
+
+`lerna exec --scope=*frontend-server yarn build`
+
+start the server with `dev` environment file
+
+`lerna exec --scope=*frontend-server yarn start:dev`
+
+Make sure backend is also running in seperate terminal
+
+`lerna exec --scope=*backend-server yarn watch`
+
+
+

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/Known_Issues.md

@@ -0,0 +1,19 @@
+
+
+# Kown Issues
+
+
+1. EACCES: permission denied, scandir .....
+
+Follow the workaround https://github.com/cdmbase/fullstack-pro/issues/176
+
+2. OS X: "Error: EMFILE: too many open files, watch"
+Follow https://github.com/facebook/create-react-app/issues/4540
+
+```
+brew install watchman
+```
+
+3. Macbook Catalina: `Zsh` latest macos comes with `Zsh` as the default shell. We seeing some issues to start the project with it. Please use `bash` to run project.
+
+https://www.howtogeek.com/444596/how-to-change-the-default-shell-to-bash-in-macos-catalina/

package/lib/generators/add-fullstack/files/docs/development/CodeContribution/Lint_And_Formatter.md

@@ -0,0 +1,9 @@
+### Lint and Formatter
+
+`eslint` and `prettier` is used along each other. `eslint-config-airbnb-base` (not `eslint-config-airbnb`, which includes `jsx` rules) is used as well. [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest/issues) and [`eslint-plugin-markdown`](https://github.com/eslint/eslint-plugin-markdown) (not for markdown itself, but for code block snippet appeared in markdown) are also configured.
+
+By configuring `overrides` in `.eslintrc.js`, both of typescript and javascript files are able to be linted by `eslint`. (e.g. So typescript rules are not applied to `.js` files.)
+
+[`markdownlint`](https://github.com/DavidAnson/markdownlint) is configured by [`markdownlint-cli`](https://github.com/igorshubovych/markdownlint-cli#readme).
+
+[`commitlint`](https://github.com/conventional-changelog/commitlint) is used as commit message linter. You can `yarn lint:md .`, for example. Refer to [conventional commits](https://www.conventionalcommits.org/en/) for more details.