├── .gitignore ├── README.md ├── package-lock.json ├── package.json ├── packages ├── cli │ ├── package.json │ ├── src │ │ └── index.ts │ └── tsconfig.json ├── core │ ├── package.json │ ├── src │ │ └── index.ts │ └── tsconfig.json └── web │ ├── package.json │ ├── src │ └── index.ts │ └── tsconfig.json ├── tsconfig.base.json └── tsconfig.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | .pnpm-debug.log* 9 | 10 | # Diagnostic reports (https://nodejs.org/api/report.html) 11 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 12 | 13 | # Runtime data 14 | pids 15 | *.pid 16 | *.seed 17 | *.pid.lock 18 | 19 | # Directory for instrumented libs generated by jscoverage/JSCover 20 | lib-cov 21 | 22 | # Coverage directory used by tools like istanbul 23 | coverage 24 | *.lcov 25 | 26 | # nyc test coverage 27 | .nyc_output 28 | 29 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 30 | .grunt 31 | 32 | # Bower dependency directory (https://bower.io/) 33 | bower_components 34 | 35 | # node-waf configuration 36 | .lock-wscript 37 | 38 | # Compiled binary addons (https://nodejs.org/api/addons.html) 39 | build/Release 40 | 41 | # Dependency directories 42 | node_modules/ 43 | jspm_packages/ 44 | 45 | # Snowpack dependency directory (https://snowpack.dev/) 46 | web_modules/ 47 | 48 | # TypeScript cache 49 | *.tsbuildinfo 50 | 51 | # Optional npm cache directory 52 | .npm 53 | 54 | # Optional eslint cache 55 | .eslintcache 56 | 57 | # Optional stylelint cache 58 | .stylelintcache 59 | 60 | # Microbundle cache 61 | .rpt2_cache/ 62 | .rts2_cache_cjs/ 63 | .rts2_cache_es/ 64 | .rts2_cache_umd/ 65 | 66 | # Optional REPL history 67 | .node_repl_history 68 | 69 | # Output of 'npm pack' 70 | *.tgz 71 | 72 | # Yarn Integrity file 73 | .yarn-integrity 74 | 75 | # dotenv environment variable files 76 | .env 77 | .env.development.local 78 | .env.test.local 79 | .env.production.local 80 | .env.local 81 | 82 | # parcel-bundler cache (https://parceljs.org/) 83 | .cache 84 | .parcel-cache 85 | 86 | # Next.js build output 87 | .next 88 | out 89 | 90 | # Nuxt.js build / generate output 91 | .nuxt 92 | dist 93 | 94 | # Gatsby files 95 | .cache/ 96 | # Comment in the public line in if your project uses Gatsby and not Next.js 97 | # https://nextjs.org/blog/next-9-1#public-directory-support 98 | # public 99 | 100 | # vuepress build output 101 | .vuepress/dist 102 | 103 | # vuepress v2.x temp and cache directory 104 | .temp 105 | .cache 106 | 107 | # Docusaurus cache and generated files 108 | .docusaurus 109 | 110 | # Serverless directories 111 | .serverless/ 112 | 113 | # FuseBox cache 114 | .fusebox/ 115 | 116 | # DynamoDB Local files 117 | .dynamodb/ 118 | 119 | # TernJS port file 120 | .tern-port 121 | 122 | # Stores VSCode versions used for testing VSCode extensions 123 | .vscode-test 124 | 125 | # yarn v2 126 | .yarn/cache 127 | .yarn/unplugged 128 | .yarn/build-state.yml 129 | .yarn/install-state.gz 130 | .pnp.* 131 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Example TypeScript monorepo using NPM workspaces 2 | 3 | An example project that uses NPM workspaces to create a Node.js TypeScript monorepo. 4 | 5 | This project is from one of my [blog article](https://daveiscoding.com/nodejs-typescript-monorepo-via-npm-workspaces)s. 6 | 7 | ## Getting started 8 | 9 | Install dependencies 10 | 11 | ``` 12 | npm i 13 | ``` 14 | 15 | Build the project 16 | 17 | ``` 18 | npm run build 19 | ``` 20 | 21 | ## Run it 22 | 23 | **CLI module** 24 | 25 | ``` 26 | npm start -w @fantastic/cli 27 | ``` 28 | 29 | **Web module** 30 | 31 | ``` 32 | npm start -w @fantastic/web 33 | ``` 34 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fantastic", 3 | "version": "1.0.0", 4 | "lockfileVersion": 2, 5 | "requires": true, 6 | "packages": { 7 | "": { 8 | "name": "fantastic", 9 | "version": "1.0.0", 10 | "license": "ISC", 11 | "workspaces": [ 12 | "packages/core", 13 | "packages/web", 14 | "packages/cli" 15 | ], 16 | "devDependencies": { 17 | "typescript": "^4.7.4" 18 | } 19 | }, 20 | "node_modules/@fantastic/cli": { 21 | "resolved": "packages/cli", 22 | "link": true 23 | }, 24 | "node_modules/@fantastic/core": { 25 | "resolved": "packages/core", 26 | "link": true 27 | }, 28 | "node_modules/@fantastic/web": { 29 | "resolved": "packages/web", 30 | "link": true 31 | }, 32 | "node_modules/typescript": { 33 | "version": "4.7.4", 34 | "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz", 35 | "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==", 36 | "dev": true, 37 | "bin": { 38 | "tsc": "bin/tsc", 39 | "tsserver": "bin/tsserver" 40 | }, 41 | "engines": { 42 | "node": ">=4.2.0" 43 | } 44 | }, 45 | "packages/cli": { 46 | "name": "@fantastic/cli", 47 | "version": "1.0.0", 48 | "license": "ISC", 49 | "dependencies": { 50 | "@fantastic/core": "^1.0.0" 51 | } 52 | }, 53 | "packages/core": { 54 | "name": "@fantastic/core", 55 | "version": "1.0.0", 56 | "license": "ISC", 57 | "devDependencies": {} 58 | }, 59 | "packages/web": { 60 | "name": "@fantastic/web", 61 | "version": "1.0.0", 62 | "license": "ISC", 63 | "dependencies": { 64 | "@fantastic/core": "^1.0.0" 65 | } 66 | } 67 | }, 68 | "dependencies": { 69 | "@fantastic/cli": { 70 | "version": "file:packages/cli", 71 | "requires": { 72 | "@fantastic/core": "^1.0.0" 73 | } 74 | }, 75 | "@fantastic/core": { 76 | "version": "file:packages/core" 77 | }, 78 | "@fantastic/web": { 79 | "version": "file:packages/web", 80 | "requires": { 81 | "@fantastic/core": "^1.0.0" 82 | } 83 | }, 84 | "typescript": { 85 | "version": "4.7.4", 86 | "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz", 87 | "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==", 88 | "dev": true 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fantastic", 3 | "version": "1.0.0", 4 | "description": "", 5 | "scripts": { 6 | "build": "tsc --build" 7 | }, 8 | "author": "Dávid Szabó", 9 | "license": "ISC", 10 | "workspaces": [ 11 | "packages/core", 12 | "packages/web", 13 | "packages/cli" 14 | ], 15 | "devDependencies": { 16 | "typescript": "^4.7.4" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /packages/cli/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@fantastic/cli", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "dist/index.js", 6 | "types": "dist/index.d.ts", 7 | "scripts": { 8 | "start": "node dist/index.js" 9 | }, 10 | "author": "Dávid Szabó", 11 | "license": "ISC", 12 | "dependencies": { 13 | "@fantastic/core": "^1.0.0" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /packages/cli/src/index.ts: -------------------------------------------------------------------------------- 1 | import "@fantastic/core"; 2 | console.log("Hello from CLI!"); 3 | -------------------------------------------------------------------------------- /packages/cli/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.base.json", 3 | "compilerOptions": { 4 | "rootDir": "src", 5 | "outDir": "dist" 6 | }, 7 | "references": [{ "path": "../core" }] 8 | } 9 | -------------------------------------------------------------------------------- /packages/core/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@fantastic/core", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "dist/index.js", 6 | "types": "dist/index.d.ts", 7 | "devDependencies": {}, 8 | "scripts": {}, 9 | "author": "Dávid Szabó", 10 | "license": "ISC" 11 | } 12 | -------------------------------------------------------------------------------- /packages/core/src/index.ts: -------------------------------------------------------------------------------- 1 | console.log("Hello from Core!"); 2 | -------------------------------------------------------------------------------- /packages/core/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.base.json", 3 | "compilerOptions": { 4 | "rootDir": "src", 5 | "outDir": "dist" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /packages/web/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@fantastic/web", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "dist/index.js", 6 | "types": "dist/index.d.ts", 7 | "scripts": { 8 | "start": "node dist/index.js" 9 | }, 10 | "author": "Dávid Szabó", 11 | "license": "ISC", 12 | "dependencies": { 13 | "@fantastic/core": "^1.0.0" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /packages/web/src/index.ts: -------------------------------------------------------------------------------- 1 | import "@fantastic/core"; 2 | console.log("Hello from Web!"); 3 | -------------------------------------------------------------------------------- /packages/web/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.base.json", 3 | "compilerOptions": { 4 | "rootDir": "src", 5 | "outDir": "dist" 6 | }, 7 | "references": [{ "path": "../core" }] 8 | } 9 | -------------------------------------------------------------------------------- /tsconfig.base.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "incremental": true, 4 | "target": "es2020", 5 | "module": "commonjs", 6 | "declaration": true, 7 | "sourceMap": true, 8 | "strict": true, 9 | "moduleResolution": "node", 10 | "esModuleInterop": true, 11 | "skipLibCheck": true, 12 | "forceConsistentCasingInFileNames": true, 13 | 14 | "composite": true 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "files": [], 3 | "references": [ 4 | { "path": "packages/core" }, 5 | { "path": "packages/cli" }, 6 | { "path": "packages/web" } 7 | ] 8 | } 9 | --------------------------------------------------------------------------------