Merge pull request #62 from wimpyprogrammer/feature/yarn-workspaces

Separate package and demo with Yarn workspaces

Author: wimpyprogrammer

.eslintignore

@@ -1,3 +1,2 @@
-/coverage/
-/demo/lib/
-/lib/
+coverage/
+lib/

.github/README.md

@@ -31,12 +31,14 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - run: npm install
+      - run: yarn
       - run: npx prettier --check .
-      - run: npm run lint
-      - run: npm run build
-      - run: npm run test
-      - run: npx testpack-cli --keep=@types/*,ts-jest,typescript jest.config.js tsconfig.json src/e2e.spec.ts src/tsconfig.test.json
+      - run: yarn run build
+      - run: yarn run lint
+      - run: yarn run test
+
+      - run: npx testpack-cli --keep=@types/*,ts-jest,typescript jest.config.js tsconfig.test.json src/e2e.spec.ts
+        working-directory: ./packages/regex-to-strings
 
       - name: Upload test coverage report to Codecov
         uses: codecov/[email protected]

.github/workflows/tests.yml

@@ -2,6 +2,5 @@ package-lock.json
 *.tsbuildinfo
 
 coverage/
-demo/lib/
 node_modules/
 lib/

.gitignore

@@ -1,2 +1,5 @@
 package-lock.json
 package.json
+
+coverage/
+lib/

.prettierignore

@@ -0,0 +1,26 @@
+{
+  "name": "regex-to-strings-demo",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "build": "wp --config webpack.config.js",
+    "test": "exit 0"
+  },
+  "devDependencies": {
+    "@types/history": "^4.7.3",
+    "@types/lodash": "^4.14.140",
+    "clean-webpack-plugin": "^4.0.0",
+    "css-loader": "^6.1.0",
+    "node-sass": "^7.0.0",
+    "sass-loader": "^12.0.0",
+    "style-loader": "^3.0.0",
+    "ts-loader": "^9.1.2",
+    "webpack": "^5.26.0",
+    "webpack-nano": "^1.1.1",
+    "worker-loader": "^3.0.8"
+  },
+  "dependencies": {
+    "regex-to-strings": "*",
+    "regexp-tree": "^0.1.23"
+  }
+}

demo/package.json

@@ -1,5 +1,6 @@
 import './polyfills';
 
+import { expand, toRegExp } from 'regex-to-strings';
 import { optimize } from 'regexp-tree';
 import {
 	CountResult,
@@ -9,7 +10,6 @@ import {
 	isExpandRequest,
 	OptimizeResult,
 } from './messages';
-import { expand, toRegExp } from '../../../src';
 
 function assertNeverRequest(x: never): never {
 	throw new TypeError(`Unexpected message: ${x}`);

demo/src/worker/index.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-classes-per-file, no-useless-constructor */
-import { expand } from '../../../src';
+import { expand } from 'regex-to-strings';
 
 interface WorkerMessage {
 	readonly kind: string;

demo/src/worker/messages.ts

@@ -8,9 +8,9 @@
 			"es2016.array.include"
 		],
 		"noEmit": true,
-		"outDir": "./lib"
+		"outDir": "lib"
 	},
 	"extends": "../tsconfig.json",
 	"include": ["src", "webpack.config.js"],
-	"references": [{ "path": "../src" }]
+	"references": [{ "path": "../packages/regex-to-strings" }]
 }

demo/tsconfig.json

@@ -4,7 +4,7 @@ const { resolve } = require('path');
 const { CleanWebpackPlugin } = require('clean-webpack-plugin');
 
 module.exports = {
-	entry: './demo/src/demo.ts',
+	entry: './src/demo.ts',
 	mode: 'production',
 	externals: {
 		history: 'History',

demo/webpack.config.js

@@ -1,77 +1,24 @@
 {
-  "name": "regex-to-strings",
-  "version": "2.1.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/wimpyprogrammer/regex-to-strings.git"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "bugs": {
-    "url": "https://github.com/wimpyprogrammer/regex-to-strings/issues"
-  },
-  "homepage": "https://github.com/wimpyprogrammer/regex-to-strings#readme",
-  "description": "Expand a regular expression pattern into a set of words",
-  "author": "Drew Keller <[email protected]>",
-  "license": "MIT",
-  "main": "lib/index.js",
-  "types": "./lib/index.d.ts",
-  "files": [
-    "lib/**/*.js",
-    "lib/**/*.js.map",
-    "lib/**/*.d.ts"
-  ],
-  "sideEffects": [
-    "demo/**/polyfills.ts",
-    "*.scss"
+  "private": true,
+  "workspaces": [
+    "packages/*",
+    "demo"
   ],
-  "engines": {
-    "node": ">=12"
-  },
   "scripts": {
-    "build": "run-s build:*",
-    "build:src": "tsc -b --clean && tsc -b",
-    "build:demo": "wp --config demo/webpack.config.js",
-    "changelog": "npx auto-changelog",
-    "format": "prettier --write '{src,demo/src}/**'",
+    "build": "yarn workspaces run build",
+    "format": "prettier --write .",
     "lint": "tsc -b ./tsconfig.lint.json && eslint . --report-unused-disable-directives",
-    "release": "npx release-it --no-increment",
-    "test": "jest --coverage"
+    "test": "yarn workspaces run test"
   },
   "devDependencies": {
-    "@types/history": "^4.7.3",
-    "@types/jest": "^27.0.1",
-    "@types/jest-when": "^3.5.0",
-    "@types/lodash": "^4.14.140",
     "@typescript-eslint/eslint-plugin": "^5.6.0",
     "@typescript-eslint/parser": "^5.6.0",
-    "clean-webpack-plugin": "^4.0.0",
-    "css-loader": "^6.1.0",
     "eslint": "^8.4.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.1.0",
     "eslint-import-resolver-typescript": "^2.4.0",
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-jest": "^26.0.0",
-    "jest": "^27.0.1",
-    "jest-when": "^3.2.1",
-    "node-sass": "^7.0.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "2.2.1",
-    "sass-loader": "^12.0.0",
-    "style-loader": "^3.0.0",
-    "ts-jest": "^27.0.1",
-    "ts-loader": "^9.1.2",
-    "typescript": "^4.2.3",
-    "webpack": "^5.26.0",
-    "webpack-nano": "^1.1.1",
-    "worker-loader": "^3.0.8"
-  },
-  "dependencies": {
-    "escape-string-regexp": "^4.0.0",
-    "pandemonium": "^2.0.0",
-    "regexp-tree": "^0.1.23"
-  },
-  "snyk": true
+    "prettier": "2.2.1"
+  }
 }

package.json

@@ -6,7 +6,7 @@ module.exports = {
 	],
 	globals: {
 		'ts-jest': {
-			tsconfig: 'src/tsconfig.test.json',
+			tsconfig: 'tsconfig.test.json',
 		},
 	},
 	preset: 'ts-jest',

CHANGELOG.md renamed to packages/regex-to-strings/CHANGELOG.md

@@ -0,0 +1,49 @@
+{
+  "name": "regex-to-strings",
+  "version": "2.1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wimpyprogrammer/regex-to-strings.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "bugs": {
+    "url": "https://github.com/wimpyprogrammer/regex-to-strings/issues"
+  },
+  "homepage": "https://github.com/wimpyprogrammer/regex-to-strings#readme",
+  "description": "Expand a regular expression pattern into a set of words",
+  "author": "Drew Keller <[email protected]>",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.js.map",
+    "lib/**/*.d.ts"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "build": "tsc -b --clean && tsc -b",
+    "changelog": "npx auto-changelog",
+    "release": "npx release-it --no-increment",
+    "test": "jest --coverage"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.1",
+    "@types/jest-when": "^3.5.0",
+    "jest": "^27.0.1",
+    "jest-when": "^3.2.1",
+    "ts-jest": "^27.0.1",
+    "typescript": "^4.2.3"
+  },
+  "dependencies": {
+    "escape-string-regexp": "^4.0.0",
+    "pandemonium": "^2.0.0",
+    "regexp-tree": "^0.1.23"
+  },
+  "snyk": true
+}

README.md renamed to packages/regex-to-strings/README.md

@@ -0,0 +1,10 @@
+{
+	"compilerOptions": {
+		"lib": ["es5", "es2015.core", "es2015.iterable", "es2016.array.include"],
+		"outDir": "lib",
+		"rootDir": "src"
+	},
+	"extends": "../../tsconfig.json",
+	"exclude": ["**/*.spec.ts", "**/*.config.js"],
+	"include": ["src"]
+}

jest.config.js renamed to packages/regex-to-strings/jest.config.js

@@ -8,10 +8,10 @@
 			"es2017.string"
 		],
 		"noEmit": true,
-		"outDir": "../lib",
-		"types": ["jest", "regexp-tree", "./types/regexp-tree"]
+		"outDir": "lib",
+		"types": ["jest", "regexp-tree", "./src/types/regexp-tree"]
 	},
-	"extends": "../tsconfig.json",
-	"include": ["./**/*.spec.ts", "../jest.config.js"],
+	"extends": "../../tsconfig.json",
+	"include": ["src/**/*.spec.ts", "jest.config.js"],
 	"references": [{ "path": "./" }]
 }

packages/regex-to-strings/package.json

@@ -23,7 +23,7 @@
 	"files": [],
 	"references": [
 		{ "path": "./demo" },
-		{ "path": "./src" },
-		{ "path": "./src/tsconfig.test.json" }
+		{ "path": "./packages/regex-to-strings" },
+		{ "path": "./packages/regex-to-strings/tsconfig.test.json" }
 	]
 }