Add a framework to reuse some build files across multiple open-source…

… projects (#5)


## PRs in the Stack
- ➡ #5

(The stack is managed by
[git-grok](https://github.com/dimikot/git-grok).)

.eslintrc.base.js

@@ -1,5 +1,5 @@
 "use strict";
-module.exports = (projectRoot) => ({
+module.exports = (projectRoot, extraRules = {}) => ({
   root: true, // fix possible "Plugin %s was conflicted between %s.json and %s.json" errors
   env: {
     jest: true,
@@ -430,5 +430,6 @@ module.exports = (projectRoot) => ({
     ],
 
     quotes: ["error", "double", { avoidEscape: true }],
+    ...extraRules,
   },
 });

.eslintrc.js

@@ -1,9 +1,9 @@
 "use strict";
-const config = require("./.eslintrc.base.js")(__dirname);
-config.rules["import/no-extraneous-dependencies"] = "error";
-config.rules["@typescript-eslint/explicit-function-return-type"] = [
-  "error",
-  { allowExpressions: true },
-];
-config.rules["lodash/import-scope"] = ["error", "method"];
-module.exports = config;
+module.exports = require("./.eslintrc.base.js")(__dirname, {
+  "import/no-extraneous-dependencies": "error",
+  "@typescript-eslint/explicit-function-return-type": [
+    "error",
+    { allowExpressions: true },
+  ],
+  "lodash/import-scope": ["error", "method"],
+});

.gitignore

@@ -1,5 +1,6 @@
 dist
 
+# Common in both .gitignore and .npmignore
 node_modules
 package-lock.json
 yarn.lock

.npmignore

@@ -1,8 +1,9 @@
-__tests__
+dist/__tests__
+dist/**/__tests__
+dist/tsconfig.tsbuildinfo
 .npmrc
-tsconfig.tsbuildinfo
-.github
 
+# Common in both .gitignore and .npmignore
 node_modules
 package-lock.json
 yarn.lock

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "mhutchie.git-graph",
+    "trentrand.git-rebase-shortcuts"
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,20 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "git grok: push local commits as individual PRs",
+      "detail": "Install git-grok first: https://github.com/dimikot/git-grok",
+      "type": "shell",
+      "command": "git grok",
+      "problemMatcher": [],
+      "hide": false
+    },
+    {
+      "label": "git rebase --interactive",
+      "detail": "Opens a UI for interactive rebase (install \"Git rebase shortcuts\" extension).",
+      "type": "shell",
+      "command": "GIT_EDITOR=\"code --wait\" git rebase -i",
+      "problemMatcher": []
+    }
+  ]
+}

internal/clean.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+rm -rf dist yarn.lock package-lock.json pnpm-lock.yaml *.log

internal/deploy.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+
+npm run build
+npm run lint
+npm run test
+npm publish --access=public

internal/docs.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+
+rm -rf docs
+typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-merge-modules
+sed -i '' -E 's#packages/[^/]+/##g' $(find docs -type f -name '*.md')

internal/lint.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+eslint . --ext .ts --cache --cache-location dist/.eslintcache

jest.config.js

@@ -4,7 +4,9 @@ module.exports = {
   testMatch: ["**/*.test.ts"],
   clearMocks: true,
   restoreMocks: true,
-  ...(process.env.IN_JEST_PROJECT ? {} : { forceExit: true }),
+  ...(process.env.IN_JEST_PROJECT
+    ? {}
+    : { forceExit: true, testTimeout: 30000, forceExit: true }),
   transform: {
     "\\.ts$": "ts-jest",
   },

package.json

@@ -13,13 +13,13 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch --preserveWatchOutput",
-    "lint": "eslint . --ext .ts --cache --cache-location dist/.eslintcache",
+    "lint": "bash internal/lint.sh",
     "test": "jest",
-    "docs": "rm -rf docs && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-merge-modules && sed -i '' -E 's#packages/[^/]+/##g' $(find docs -type f -name '*.md')",
-    "clean": "rm -rf dist node_modules yarn.lock package-lock.json pnpm-lock.yaml *.log",
+    "docs": "bash internal/docs.sh",
+    "clean": "bash internal/clean.sh",
     "copy-package-to-public-dir": "copy-package-to-public-dir.sh",
     "backport-package-from-public-dir": "backport-package-from-public-dir.sh",
-    "deploy": "npm run build && npm run lint && npm run test && npm publish --access=public"
+    "deploy": "bash internal/deploy.sh"
   },
   "dependencies": {
     "lodash": "^4.17.21",

tsconfig.base.json

@@ -0,0 +1,31 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "disableReferencedProjectLoad": true,
+    "disableSourceOfProjectReferenceRedirect": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "incremental": true,
+    "lib": ["ES2019"],
+    "module": "Node16",
+    "noEmitOnError": true,
+    "noErrorTruncation": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "outDir": "dist",
+    "pretty": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "rootDir": "src",
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2019",
+    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
+    "types": ["node", "jest"]
+  }
+}

tsconfig.json

@@ -1,31 +1,4 @@
 {
-  "include": ["src/**/*"],
-  "compilerOptions": {
-    "allowJs": true,
-    "declaration": true,
-    "declarationMap": true,
-    "disableReferencedProjectLoad": true,
-    "disableSourceOfProjectReferenceRedirect": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "incremental": true,
-    "lib": ["ES2019"],
-    "module": "Node16",
-    "noEmitOnError": true,
-    "noErrorTruncation": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "outDir": "dist",
-    "pretty": true,
-    "removeComments": false,
-    "resolveJsonModule": true,
-    "rootDir": "src",
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "target": "ES2019",
-    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo",
-    "types": ["node", "jest"]
-  }
+  "extends": "./tsconfig.base.json",
+  "include": ["src/**/*"]
 }

typedoc.config.js

@@ -0,0 +1,20 @@
+"use strict";
+const { basename } = require("path");
+
+module.exports = {
+  entryPoints: ["src"],
+  exclude: ["**/internal/**", "**/__tests__/**", "**/node_modules/**"],
+  entryPointStrategy: "expand",
+  mergeModulesMergeMode: "project",
+  sort: ["source-order"],
+  out: "docs",
+  logLevel: "Warn",
+  hideGenerator: true,
+  excludeInternal: true,
+  excludePrivate: true,
+  categorizeByGroup: true,
+  hideInPageTOC: true,
+  gitRevision: "master",
+  sourceLinkTemplate: `https://github.com/clickup/${basename(__dirname)}/blob/master/{path}#L{line}`,
+  basePath: ".",
+};