feat: use TypeScript for source config files (#46)

Resolves #33

Switch to TypeScript to have a better code base for the future.

.changeset/hungry-cups-relate.md

@@ -0,0 +1,6 @@
+---
+'@mheob/eslint-config': patch
+'@mheob/prettier-config': patch
+---
+
+Switch to typescript as source files

.github/workflows/check.yml

@@ -0,0 +1,37 @@
+name: Check
+
+on:
+  pull_request:
+    paths: ["packages/**"]
+    branches: [main]
+  push:
+    paths: ["packages/**"]
+    branches: [main]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Setup PNPM
+        uses: pnpm/action-setup@v2
+        with:
+          version: 7
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: "pnpm"
+
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build files
+        run: pnpm run build
+
+      - name: Lint files
+        run: pnpm run lint

.github/workflows/release.yml

@@ -32,6 +32,9 @@ jobs:
       - name: Install Dependencies
         run: pnpm install --frozen-lockfile
 
+      - name: Build files
+        run: pnpm run build
+
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1

.gitignore

@@ -8,10 +8,11 @@ node_modules
 # testing
 coverage
 
-# next.js
+# builds
 .next/
-out/
+out
 build
+dist
 
 # misc
 .DS_Store

.prettierignore

@@ -9,3 +9,9 @@ coverage
 
 # turbo
 .turbo
+
+# builds
+.next/
+out
+build
+dist

package.json

@@ -7,6 +7,7 @@
 		"packages/*"
 	],
 	"scripts": {
+		"build": "turbo run build",
 		"changeset": "changeset",
 		"clean": "turbo run clean",
 		"clean:root": "rm -rf .turbo && rm -rf node_modules",
@@ -25,7 +26,7 @@
 	"lint-staged": {
 		"*.{cjs,js,jsx,ts,tsx}": "eslint --fix",
 		"!(pnpm-)*.{cjs,js,jsx,ts,tsx,json,md,mdx,yml,yaml}": "pnpm exec prettier --write",
-		"**/package.json": "pnpm dlx sort-package-json"
+		"package.json": "pnpm dlx sort-package-json"
 	},
 	"devDependencies": {
 		"@changesets/cli": "^2.24.4",
@@ -35,7 +36,7 @@
 		"@mheob/prettier-config": "workspace:*",
 		"@types/node": "^18.7.18",
 		"eslint": "^8.23.1",
-		"husky": "^8.0.0",
+		"husky": "^8.0.1",
 		"lint-staged": "^13.0.3",
 		"prettier": "^2.7.1",
 		"ts-node": "^10.9.1",

packages/eslint-config/.eslintrc.cjs

@@ -1,6 +1,6 @@
 /** @type {import('eslint').ESLint.ConfigData} */
 module.exports = {
-	extends: ['./base.js'],
+	extends: ['./dist/base.js'],
 	env: { node: true },
 	rules: {
 		'unicorn/prefer-module': 'off',

packages/eslint-config/package.json

@@ -10,22 +10,19 @@
 	"bugs": "https://github.com/mheob/config/issues",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/mheob/config.git"
+		"url": "https://github.com/mheob/config"
 	},
 	"license": "MIT",
 	"author": "Alexander Böhm <tools@boehm.work>",
-	"main": "index.js",
-	"types": "index.d.ts",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"files": [
-		"index.js",
-		"index.d.ts",
-		"base.js",
-		"next.js",
-		"react.js",
+		"dist",
 		"LICENSE",
 		"README.md"
 	],
 	"scripts": {
+		"build": "tsc",
 		"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
 		"lint": "eslint **/*.cjs --fix",
 		"sort-package-json": "pnpm dlx sort-package-json"
@@ -40,6 +37,8 @@
 		"eslint-plugin-unicorn": "^43.0.2"
 	},
 	"devDependencies": {
+		"@mheob/tsconfig": "workspace:*",
+		"@types/eslint": "^8.4.6",
 		"eslint": "^8.23.1",
 		"prettier": "^2.7.1",
 		"typescript": "^4.8.3"

packages/eslint-config/base.js → packages/eslint-config/src/base.ts

@@ -1,8 +1,6 @@
-/**
- * Base ESLint rules
- * @type {import('eslint').ESLint.ConfigData}
- */
-module.exports = {
+import type { Linter } from 'eslint';
+
+const config: Linter.Config = {
 	plugins: ['@typescript-eslint'],
 	extends: ['eslint:recommended', 'plugin:unicorn/recommended', 'plugin:prettier/recommended'],
 	rules: {
@@ -50,3 +48,5 @@ module.exports = {
 		},
 	],
 };
+
+export = config;

packages/eslint-config/src/index.ts

@@ -0,0 +1 @@
+export = require('./base');

packages/eslint-config/src/next.ts

@@ -0,0 +1,7 @@
+import type { Linter } from 'eslint';
+
+const config: Linter.Config = {
+	extends: ['./react', 'next/core-web-vitals'],
+};
+
+export = config;

packages/eslint-config/react.js → packages/eslint-config/src/react.ts

@@ -1,8 +1,6 @@
-/**
- * React specific ESLint rules
- * @type {import('eslint').ESLint.ConfigData}
- */
-module.exports = {
+import type { Linter } from 'eslint';
+
+const config: Linter.Config = {
 	extends: ['./base', 'plugin:eslint-plugin-react/recommended'],
 	settings: {
 		react: {
@@ -23,3 +21,5 @@ module.exports = {
 		},
 	],
 };
+
+export = config;

packages/eslint-config/tsconfig.json

@@ -0,0 +1,9 @@
+{
+	"extends": "@mheob/tsconfig/commonjs.json",
+	"compilerOptions": {
+		"declaration": true,
+		"outDir": "dist",
+		"rootDir": "src"
+	},
+	"include": ["src/**/*"]
+}

packages/prettier-config/package.json

@@ -10,21 +10,20 @@
 	"bugs": "https://github.com/mheob/config/issues",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/mheob/config.git"
+		"url": "https://github.com/mheob/config"
 	},
 	"license": "MIT",
 	"author": "Alexander Böhm <tools@boehm.work>",
-	"main": "index.cjs",
-	"types": "index.d.ts",
+	"main": "dist/index.js",
 	"files": [
-		"index.cjs",
-		"index.d.ts",
+		"dist",
 		"LICENSE",
 		"README.md"
 	],
 	"scripts": {
+		"build": "tsc",
 		"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
-		"lint": "eslint **/*.cjs --fix",
+		"lint": "eslint **/*.ts --fix",
 		"sort-package-json": "pnpm dlx sort-package-json"
 	},
 	"dependencies": {
@@ -33,6 +32,8 @@
 	},
 	"devDependencies": {
 		"@mheob/eslint-config": "workspace:*",
+		"@mheob/tsconfig": "workspace:*",
+		"@types/prettier": "^2.7.0",
 		"eslint": "^8.23.1",
 		"prettier": "^2.7.1"
 	},

packages/prettier-config/src/index.ts

@@ -0,0 +1,46 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import sortImports from '@trivago/prettier-plugin-sort-imports';
+import type { Config as DefaultConfig } from 'prettier';
+
+interface Config extends DefaultConfig {
+	importOrder?: string[];
+	importOrderCaseInsensitive?: boolean;
+	importOrderParserPlugins?: string[];
+	importOrderSeparation?: boolean;
+	importOrderGroupNamespaceSpecifiers?: boolean;
+	importOrderSortSpecifiers?: boolean;
+}
+
+const options: Config = {
+	plugins: [sortImports],
+	arrowParens: 'always',
+	endOfLine: 'lf',
+	printWidth: 100,
+	proseWrap: 'always',
+	importOrder: ['^node:', '<THIRD_PARTY_MODULES>', '^[./]'],
+	importOrderSeparation: true,
+	importOrderSortSpecifiers: true,
+	singleQuote: true,
+	semi: true,
+	trailingComma: 'all',
+	useTabs: true,
+
+	overrides: [
+		{
+			files: '*.{yaml,yml}',
+			options: {
+				printWidth: 130,
+				singleQuote: false,
+			},
+		},
+		{
+			files: '*.md',
+			options: {
+				printWidth: 130,
+			},
+		},
+	],
+};
+
+export = options;

packages/prettier-config/tsconfig.json

@@ -0,0 +1,9 @@
+{
+	"extends": "@mheob/tsconfig/commonjs.json",
+	"compilerOptions": {
+		"declaration": true,
+		"outDir": "dist",
+		"rootDir": "src"
+	},
+	"include": ["src/**/*"]
+}

packages/tsconfig/package.json

@@ -13,7 +13,7 @@
 	"bugs": "https://github.com/mheob/config/issues",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/mheob/config.git"
+		"url": "https://github.com/mheob/config"
 	},
 	"license": "MIT",
 	"author": "Alexander Böhm <tools@boehm.work>",