refactor: extract @beautiful-tree/types pkg

castarco · castarco · commit 298e78fad92d · 2023-09-16T23:58:45.000+02:00
Signed-off-by: Andres Correa Casablanca &lt;castarco@coderspirit.xyz&gt;
diff --git a/.editorconfig b/.editorconfig
diff --git a/.github/workflows/tests-react-svg.yml b/.github/workflows/tests-react-svg.yml
@@ -1,4 +1,4 @@
-name: Tests (React SVG)
+name: Tests
 
 on:
   push:
@@ -33,12 +33,23 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'pnpm'
-    - name: Install dependencies
+
+    # @beautiful-tree/types
+    - name: (Types) Install dependencies
+      run: pnpm --filter types install
+    - name: (Types) Build Library
+      run: pnpm --filter types run build
+    - name: (Types) Run Linters
+      if: ${{ matrix.os == 'ubuntu-22.04' }}
+      run: pnpm --filter types run lint
+
+    # @beautiful-tree/react
+    - name: (React SVG) Install dependencies
       run: pnpm --filter react install
-    - name: Build Library
+    - name: (React SVG) Build Library
       run: pnpm --filter react run build
-    - name: Run Linters
+    - name: (React SVG) Run Linters
       if: ${{ matrix.os == 'ubuntu-22.04' }}
       run: pnpm --filter react run lint
-    - name: Run Tests
+    - name: (React SVG) Run Tests
       run: pnpm --filter react run test:coverage
diff --git a/@beautiful-tree/react/.eslintrc.cjs b/@beautiful-tree/react/.eslintrc.cjs
@@ -8,11 +8,11 @@ module.exports = {
 	},
 	parser: '@typescript-eslint/parser',
 	parserOptions: {
-    ecmaVersion: 2020,
+		ecmaVersion: 2020,
 		sourceType: 'module',
-    tsConfigRootDir: __dirname,
-    project: ['./tsconfig.json'],
-  },
+		tsConfigRootDir: __dirname,
+		project: ['./tsconfig.json'],
+	},
 	plugins: [
 		'react-refresh',
 	],
@@ -24,10 +24,10 @@ module.exports = {
 		'plugin:storybook/recommended',
 	],
 	settings: {
-    react: {
-      version: 'detect'
-    },
-  },
+		react: {
+			version: 'detect'
+		},
+	},
 	ignorePatterns: [
 		'.eslintrc.cjs',
 		'dist/**/*',
diff --git a/@beautiful-tree/react/package.json b/@beautiful-tree/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@beautiful-tree/react",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "private": false,
   "author": "Andres Correa Casablanca <castarco@coderspirit.xyz>",
   "license": "MIT",
@@ -37,20 +37,21 @@
     "dist"
   ],
   "scripts": {
-    "build": "rollup --config rollup.config.prod.mjs",
+    "build": "rm -rf dist && rollup --config rollup.config.prod.mjs",
     "build-storybook": "storybook build",
-    "install-githooks": "if [ -d .git ]; then git config core.hooksPath .hooks; fi",
     "lint": "tsc && eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0 && publint",
     "lint:eslint": "eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0",
     "lint:publint": "publint",
     "lint:tsc": "tsc",
     "storybook": "storybook dev -p 6006",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "prepublishOnly": "pnpm run build"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.10.2",
+    "@beautiful-tree/types": "workspace:0.2.0",
     "@coderspirit/eslint-config": "^1.2.1",
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.3",
diff --git a/@beautiful-tree/react/rollup.config.prod.mjs b/@beautiful-tree/react/rollup.config.prod.mjs
@@ -85,6 +85,6 @@ export default defineConfig([
 			{ format: 'es', file: 'dist/beautiful-tree.d.mts' },
 		],
 		external,
-		plugins: [dts()],
+		plugins: [dts({ respectExternal: true })],
 	},
 ])
diff --git a/@beautiful-tree/react/src/BeautifulTree.tsx b/@beautiful-tree/react/src/BeautifulTree.tsx
@@ -1,6 +1,6 @@
 import { edgesIterator, postOrderIterator } from './traversal'
 import { Fragment } from 'react'
-import type { Tree } from './types'
+import type { Tree } from '@beautiful-tree/types'
 import type { WrappedTreeWithLayout } from './layouts'
 import { computeSmartLayout } from './layouts'
 export { computeNaiveLayout, computeSmartLayout } from './layouts'
diff --git a/@beautiful-tree/react/src/layouts.ts b/@beautiful-tree/react/src/layouts.ts
@@ -1,4 +1,4 @@
-import type { Tree, TreeChild, TreeWithLayout } from './types'
+import type { Tree, TreeChild, TreeWithLayout } from '@beautiful-tree/types'
 
 export interface WrappedTreeWithLayout {
 	readonly tree: Readonly<TreeWithLayout>
diff --git a/@beautiful-tree/react/src/stories/BeautifulTree.stories.ts b/@beautiful-tree/react/src/stories/BeautifulTree.stories.ts
@@ -17,7 +17,7 @@ import {
 	wideTree_E,
 	wideTree_M,
 } from './treeFixtures'
-import type { Tree } from '../types'
+import type { Tree } from '@beautiful-tree/types'
 
 const meta = {
 	title: 'BeautifulTree',
diff --git a/@beautiful-tree/react/src/stories/treeFixtures.ts b/@beautiful-tree/react/src/stories/treeFixtures.ts
@@ -1,4 +1,4 @@
-import type { Tree } from '../types'
+import type { Tree } from '@beautiful-tree/types'
 
 const mirrorTree = (tree: Tree): Tree => {
 	const children = tree.children?.map((child) => ({
diff --git a/@beautiful-tree/react/src/tests/traversal.test.ts b/@beautiful-tree/react/src/tests/traversal.test.ts
@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest'
 import { edgesIterator, postOrderIterator } from '../traversal'
-import type { TreeWithLayout } from '../types'
+import type { TreeWithLayout } from '@beautiful-tree/types'
 
 describe('postOrderIterator', () => {
 	const testTree = {
diff --git a/@beautiful-tree/react/src/traversal.ts b/@beautiful-tree/react/src/traversal.ts
@@ -1,4 +1,4 @@
-import type { Edge, Tree, TreeWithLayout } from './types'
+import type { Edge, Tree, TreeWithLayout } from '@beautiful-tree/types'
 
 export function* postOrderIterator<T extends Tree | TreeWithLayout = Tree>(
 	tree: Readonly<T>,
diff --git a/@beautiful-tree/react/tsconfig.json b/@beautiful-tree/react/tsconfig.json
@@ -1,19 +1,10 @@
 {
-	"extends": "@coderspirit/eslint-config/tsconfig",
+	"extends": "../../tsconfig.json",
 	"compilerOptions": {
-		"target": "es2020",
-		"lib": ["ES2020", "DOM", "DOM.Iterable"],
-
-		"module": "ES2020",
-		"moduleResolution": "Bundler",
-
 		"jsx": "react-jsx",
 		"baseUrl": "./src",
-		"noEmit": true,
 	},
 	"exclude": [
-		".github/**/*",
-		".hooks/**/*",
 		"coverage/**/*",
 		"dist/**/*",
 		"node_modules/**/*",
diff --git a/@beautiful-tree/types/.eslintrc.cjs b/@beautiful-tree/types/.eslintrc.cjs
@@ -0,0 +1,23 @@
+'use strict';
+
+module.exports = {
+	root: true,
+	env: {
+		es2020: true,
+	},
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		ecmaVersion: 2020,
+		sourceType: 'module',
+		tsConfigRootDir: __dirname,
+		project: ['./tsconfig.json'],
+	},
+	extends: [
+		'@coderspirit',
+	],
+	ignorePatterns: [
+		'.eslintrc.cjs',
+		'dist/**/*',
+		'node_modules/**/*',
+	]
+}
diff --git a/@beautiful-tree/types/.prettierrc.mjs b/@beautiful-tree/types/.prettierrc.mjs
@@ -0,0 +1,3 @@
+import config from '@coderspirit/eslint-config/prettier'
+
+export default config
diff --git a/@beautiful-tree/types/package.json b/@beautiful-tree/types/package.json
@@ -0,0 +1,43 @@
+{
+  "name": "@beautiful-tree/types",
+  "version": "0.2.0",
+  "private": false,
+  "author": "Andres Correa Casablanca <castarco@coderspirit.xyz>",
+  "license": "MIT",
+  "types": "./dist/types.d.cts",
+  "exports": {
+    "import": {
+      "types": "./dist/types.d.mts"
+    },
+    "require": {
+      "types": "./dist/types.d.cts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rm -rf dist && rollup --config rollup.config.prod.mjs",
+    "lint": "tsc && eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0 && publint",
+    "lint:eslint": "eslint . --ext ts,mts,tsx --report-unused-disable-directives --max-warnings 0",
+    "lint:publint": "publint",
+    "lint:tsc": "tsc",
+    "test": "true",
+    "test:coverage": "true",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.10.2",
+    "@coderspirit/eslint-config": "^1.2.1",
+    "@rollup/plugin-typescript": "^11.1.3",
+    "@types/node": "^20.6.1",
+    "@typescript-eslint/parser": "^6.7.0",
+    "eslint": "^8.49.0",
+    "prettier": "^3.0.3",
+    "publint": "^0.2.2",
+    "rollup": "^3.29.1",
+    "rollup-plugin-dts": "^5.3.1",
+    "tslib": "^2.6.2",
+    "typescript": "^5.2.2"
+  }
+}
diff --git a/@beautiful-tree/types/rollup.config.prod.mjs b/@beautiful-tree/types/rollup.config.prod.mjs
@@ -0,0 +1,15 @@
+import { defineConfig } from 'rollup'
+import dts from 'rollup-plugin-dts'
+
+const input = 'src/types.ts'
+
+export default defineConfig([
+	{
+		input,
+		output: [
+			{ format: 'cjs', file: 'dist/types.d.cts' },
+			{ format: 'es', file: 'dist/types.d.mts' },
+		],
+		plugins: [dts()],
+	},
+])
diff --git a/@beautiful-tree/types/src/types.ts b/@beautiful-tree/types/src/types.ts
diff --git a/@beautiful-tree/types/tsconfig.json b/@beautiful-tree/types/tsconfig.json
@@ -0,0 +1,6 @@
+{
+	"extends": "../../tsconfig.json",
+	"compilerOptions": {
+		"baseUrl": "./src",
+	},
+}
diff --git a/package.json b/package.json
@@ -3,5 +3,8 @@
   "version": "0.1.3",
   "private": true,
   "author": "Andres Correa Casablanca <castarco@coderspirit.xyz>",
-  "license": "MIT"
+  "license": "MIT",
+  "scripts": {
+    "install-githooks": "if [ -d .git ]; then git config core.hooksPath .hooks; fi"
+  }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,20 @@
+{
+	"extends": "@coderspirit/eslint-config/tsconfig",
+	"compilerOptions": {
+		"target": "es2020",
+		"lib": ["ES2020", "DOM", "DOM.Iterable"],
+
+		"module": "ES2020",
+		"moduleResolution": "Bundler",
+
+		"noEmit": true,
+	},
+	"exclude": [
+		".github/**/*",
+		".hooks/**/*",
+		"coverage/**/*",
+		"dist/**/*",
+		"node_modules/**/*",
+		"storybook-static/**/*",
+	]
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { Tree, TreeChild, TreeWithLayout } from './types'`
	`1`	`+import type { Tree, TreeChild, TreeWithLayout } from '@beautiful-tree/types'`
`2`	`2`
`3`	`3`	`export interface WrappedTreeWithLayout {`
`4`	`4`	`readonly tree: Readonly<TreeWithLayout>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { Tree } from '../types'`
	`1`	`+import type { Tree } from '@beautiful-tree/types'`
`2`	`2`
`3`	`3`	`const mirrorTree = (tree: Tree): Tree => {`
`4`	`4`	`const children = tree.children?.map((child) => ({`