chore: setup Lerna + Yarn Workspaces + TypeScript Project References

Author: koba04

.eslintignore

@@ -0,0 +1 @@
+packages/*/lib/

.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: 'smarthr',
+  settings: {
+    react: {
+      version: 'latest',
+    },
+  },
+}

.gitignore

@@ -0,0 +1,3 @@
+packages/*/lib/
+node_modules/
+tsconfig.tsbuildinfo

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "semi": false,
+  "printWidth": 100
+}

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing Guide
+
+## For Contributors
+
+Thank you for your contribution!
+
+### Setup
+
+This repository is a monorepo using Lerna and Yarn Workspaces.
+
+```sh
+% cd tamatebako
+% yarn install
+```
+
+### Develop
+
+```sh
+% yarn start
+```
+
+### Test
+
+```sh
+% cd tamatebako
+% yarn test
+% yarn lint
+```
+
+## For Maintainers
+
+### Merge
+
+After you have approved a PR, please merge the PR using Squash and merge with Conventional Commits format.
+
+### Release
+
+```sh
+% cd tamatebako
+% yarn release
+```
+
+If you'd like to release a new package.
+
+```sh
+% cd tamatebako
+% yarn initial:release
+```

README.md

@@ -1 +1,9 @@
-# tamatebako
+# tamatebako
+
+Frontend packages for projects at SmartHR
+
+### Package Index
+
+| Package | Version | Description |
+| ------- | ------- | ----------- |
+| TBD     | TBD     | TBD         |

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testRegex: '.*\\.test\\.tsx?$',
+}

lerna.json

@@ -0,0 +1,5 @@
+{
+  "npmClient": "yarn",
+  "useWorkspaces": true,
+  "version": "independent"
+}

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "tamatebako",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Frontend packages for projects at SmartHR",
+  "workspaces": [
+    "packages/*"
+  ],
+  "main": "index.js",
+  "scripts": {
+    "build": "yarn tsc",
+    "prebuild": "lerna run clean --stream",
+    "lint": "eslint '**/*.{ts,tsx}'",
+    "release": "lerna publish --conventional-commits",
+    "prerelease": "yarn build && yarn lint && yarn test",
+    "initial:release": "lerna publish from-package",
+    "preinitial:release": "yarn prerelease",
+    "start": "yarn build --watch",
+    "tsc": "tsc --build packages --force",
+    "test": "jest"
+  },
+  "author": "SmartHR",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^26.0.3",
+    "eslint": "^7.2.0",
+    "eslint-config-smarthr": "^4.0.0",
+    "jest": "^26.1.0",
+    "lerna": "^3.22.1",
+    "prettier": "^2.0.5",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^26.1.1",
+    "typescript": "^3.9.5"
+  }
+}

packages/package-a/README.md

@@ -0,0 +1,8 @@
+# `@smarthr/package-a`
+
+## Usage
+
+```
+const { fnA } = require('@smarthr/package-a');
+fnA();
+```

packages/package-a/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@smarthr/package-a",
+  "version": "1.0.0",
+  "description": "A test library",
+  "author": "SmartHR",
+  "homepage": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kufu/tamatebako.git",
+    "directory": "packages/pacakge-a"
+  },
+  "bugs": {
+    "url": "https://github.com/kufu/tamatebako/issues"
+  },
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prebuild": "yarn clean",
+    "clean": "rimraf lib"
+  }
+}

packages/package-a/src/__tests__/index.test.ts

@@ -0,0 +1,14 @@
+import { fnA, fnAB } from '../index'
+
+describe('package-a', () => {
+  describe('fnA', () => {
+    it('should return A', () => {
+      expect(fnA()).toBe('A')
+    })
+  })
+  describe('fnAB', () => {
+    it('should return AB', () => {
+      expect(fnAB()).toBe('AB')
+    })
+  })
+})

packages/package-a/src/index.ts

@@ -0,0 +1,4 @@
+import { fnB } from '@smarthr/package-b'
+
+export const fnA = () => 'A'
+export const fnAB = () => fnA() + fnB()

packages/package-a/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig-base.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "rootDir": "./src"
+  },
+  "references": [
+    { "path": "../package-b" }
+  ]
+}

packages/package-b/README.md

@@ -0,0 +1,8 @@
+# `@smarthr/package-b`
+
+## Usage
+
+```
+const { fnB } = require('@smarthr/package-b');
+fnB();
+```

packages/package-b/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@smarthr/package-b",
+  "version": "1.0.0",
+  "description": "A test library",
+  "author": "SmartHR",
+  "homepage": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kufu/tamatebako.git",
+    "directory": "packages/pacakge-b"
+  },
+  "bugs": {
+    "url": "https://github.com/kufu/tamatebako/issues"
+  },
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prebuild": "yarn clean",
+    "clean": "rimraf lib"
+  }
+}

packages/package-b/src/__tests__/index.test.ts

@@ -0,0 +1,7 @@
+import { fnB } from '../index'
+
+describe('package-b', () => {
+  it('should return B', () => {
+    expect(fnB()).toBe('B')
+  })
+})

packages/package-b/src/index.ts

@@ -0,0 +1 @@
+export const fnB = () => 'B'

packages/package-b/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig-base.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "rootDir": "./src"
+  }
+}

packages/tsconfig-base.json

@@ -0,0 +1,69 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}

packages/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "files": [],
+  "include": [],
+  "references": [
+    { "path": "./package-a" },
+    { "path": "./package-b" }
+  ]
+}