Merge pull request #260 from AndreaPontrandolfo/AndreaPontrandolfo/is…

…sue233 AndreaPontrandolfo/issue233
AndreaPontrandolfo · Sep 22, 2024 · 41cf80a · 41cf80a
2 parents 58e200e + 8bbde20
commit 41cf80a
Show file tree

Hide file tree

Showing 18 changed files with 50 additions and 185 deletions.
diff --git a/.changeset/few-news-relax.md b/.changeset/few-news-relax.md
@@ -0,0 +1,9 @@
+---
+'eslint-config-sheriff': major
+'@sherifforg/create-config': patch
+'@sherifforg/cli': patch
+'docs-website': patch
+---
+
+feat(types): now Sheriff types are exposed through the eslint-config-sheriff package instead of @sherifforg/types.
+Closes #233
diff --git a/README.md b/README.md
@@ -18,7 +18,6 @@ This repository is a monorepo that hosts the sourcecode of the following project
 | [`eslint-config-sheriff`](https://www.npmjs.com/package/eslint-config-sheriff) | [eslint-config-sheriff](https://github.com/AndreaPontrandolfo/sheriff/tree/master/packages/eslint-config-sheriff) | A comprehensive and opinionated Typescript-first ESLint configuration | [![npm](https://img.shields.io/npm/v/eslint-config-sheriff.svg)](https://www.npmjs.com/package/eslint-config-sheriff)                                    |
 | [`@sherifforg/create-config`](https://www.npmjs.com/package/@sherifforg/create-config) | [sheriff-create-config](https://github.com/AndreaPontrandolfo/sheriff/tree/master/packages/sheriff-create-config) | Package used to create Sheriff-based ESLint configs                             | [![npm](https://img.shields.io/npm/v/@sherifforg/create-config.svg)](https://www.npmjs.com/package/@sherifforg/create-config)                                    |
 | [`@sherifforg/cli`](https://www.npmjs.com/package/@sherifforg/cli) | [sheriff-cli](https://github.com/AndreaPontrandolfo/sheriff/tree/master/packages/sheriff-cli) | The Sheriff CLI. Used to manage Sheriff-based ESLint configs                             | [![npm](https://img.shields.io/npm/v/@sherifforg/cli.svg)](https://www.npmjs.com/package/@sherifforg/cli)                                    |
-| [`@sherifforg/types`](https://www.npmjs.com/package/@sherifforg/types)         | [sheriff-types](https://github.com/AndreaPontrandolfo/sheriff/tree/master/packages/sheriff-types)                 | Sheriff types package                                                 | [![npm](https://img.shields.io/npm/v/@sherifforg/types.svg)](https://www.npmjs.com/package/@sherifforg/types)                                            |
 
 ## 🚀 Getting Started
 

diff --git a/apps/docs-website/docs/configuration.mdx b/apps/docs-website/docs/configuration.mdx
@@ -50,9 +50,8 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 // highlight-start
 // Sheriff configuration object
@@ -113,9 +112,8 @@ export default defineFlatConfig([
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -177,9 +175,8 @@ export default defineFlatConfig([
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -269,9 +266,8 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -331,9 +327,8 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -407,9 +402,8 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -480,9 +474,8 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -559,9 +552,8 @@ export default defineFlatConfig([
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -637,9 +629,8 @@ export default defineFlatConfig([
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff, { baseNoRestrictedSyntaxRules } from "eslint-config-sheriff";
+import sheriff, { baseNoRestrictedSyntaxRules, type SheriffSettings } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,
@@ -716,9 +707,8 @@ export default defineFlatConfig([
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,

diff --git a/apps/docs-website/docs/migration-guide.mdx b/apps/docs-website/docs/migration-guide.mdx
@@ -50,9 +50,8 @@ export default defineFlatConfig([...sheriff(sheriffOptions)]);
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   // highlight-next-line

diff --git a/apps/docs-website/docs/performance-considerations.mdx b/apps/docs-website/docs/performance-considerations.mdx
@@ -72,9 +72,8 @@ export default defineFlatConfig([
 <TabItem value="TS" label="TS">
 
 ```ts title="eslint.config.ts"
-import sheriff from "eslint-config-sheriff";
+import sheriff, { type SheriffSettings  } from "eslint-config-sheriff";
 import { defineFlatConfig } from "eslint-define-config";
-import type { SheriffSettings } from "@sherifforg/types";
 
 const sheriffOptions: SheriffSettings = {
   react: false,

diff --git a/apps/docs-website/docs/setup/manual-setup.mdx b/apps/docs-website/docs/setup/manual-setup.mdx
@@ -72,15 +72,14 @@ Follow these steps:
 
       -
         ```bash npm2yarn
-        npm install -D eslint-ts-patch eslint@npm:eslint-ts-patch @sherifforg/types
+        npm install -D eslint-ts-patch eslint@npm:eslint-ts-patch
         ```
       - change the extension of `eslint.config.mjs` from `.mjs` to `.ts`
       - define the types of the `sheriffOptions` object:
 
         ```ts title="eslint.config.ts"
-        import sheriff from "eslint-config-sheriff";
+        import sheriff, { SheriffSettings } from "eslint-config-sheriff";
         import { defineFlatConfig } from "eslint-define-config";
-        import type { SheriffSettings } from "@sherifforg/types";
 
         const sheriffOptions: SheriffSettings = {
           react: false,

diff --git a/packages/eslint-config-sheriff/package.json b/packages/eslint-config-sheriff/package.json
@@ -6,6 +6,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     }
   },
@@ -49,8 +50,7 @@
     "build-watch": "tsup",
     "typecheck": "tsc --noEmit",
     "publint": "publint",
-    "typesync": "typesync --dry=fail",
-    "are-the-types-wrong": "attw $(pnpm pack) --ignore-rules cjs-resolves-to-esm no-resolution && rm eslint-config-sheriff-*.tgz"
+    "typesync": "typesync --dry=fail"
   },
   "dependencies": {
     "@eslint-react/eslint-plugin": "^1.10.1",
@@ -94,7 +94,6 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.15.4",
     "@sherifforg/constants": "workspace:*",
     "@sherifforg/types": "workspace:*",
     "@types/confusing-browser-globals": "^1.0.3",

diff --git a/packages/eslint-config-sheriff/src/index.ts b/packages/eslint-config-sheriff/src/index.ts
@@ -22,4 +22,7 @@ export {
   supportedFileTypes,
   testsFilePatterns,
 };
+
+export type * from '@sherifforg/types';
+
 export default getExportableConfig;
diff --git a/packages/sheriff-cli/src/utils/getEslintConfigRawText.ts b/packages/sheriff-cli/src/utils/getEslintConfigRawText.ts
@@ -18,9 +18,8 @@ export const getEslintConfigRawText = async (
   }
 
   const eslintConfigRawText = {
-    ts: `import sheriff from 'eslint-config-sheriff';
+    ts: `import sheriff, { type SheriffSettings } from 'eslint-config-sheriff';
 import { defineFlatConfig } from 'eslint-define-config';
-import type { SheriffSettings } from '@sherifforg/types';
 
 const sheriffOptions: SheriffSettings = ${JSON.stringify(
       sheriffConfig,

diff --git a/packages/sheriff-cli/src/utils/getRequiredPackages.ts b/packages/sheriff-cli/src/utils/getRequiredPackages.ts
@@ -17,8 +17,6 @@ export const getRequiredPackages = (
   if (isEslintTsPatchRequired) {
     requiredPackages.push(`eslint-ts-patch`, `eslint@npm:eslint-ts-patch`);
     consola.start("Installing 'eslint-ts-patch'...");
-    requiredPackages.push('@sherifforg/types');
-    consola.start("Installing '@sherifforg/types'...");
   }
 
   return requiredPackages;

diff --git a/packages/sheriff-constants/package.json b/packages/sheriff-constants/package.json
@@ -1,15 +1,13 @@
 {
   "name": "@sherifforg/constants",
   "description": "Sheriff constants.",
-  "version": "0.1.1",
   "private": true,
   "type": "module",
   "exports": {
     ".": "./src/index.ts"
   },
   "files": [
-    "src",
-    "CHANGELOG.md"
+    "src"
   ],
   "scripts": {
     "clean": "rm -rf .turbo"
@@ -18,5 +16,18 @@
     "@sherifforg/types": "workspace:*",
     "tsconfig": "workspace:*",
     "typescript": "^5.5.3"
+  },
+  "engines": {
+    "node": ">=20.10.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AndreaPontrandolfo/sheriff.git",
+    "directory": "packages/sheriff-constants"
+  },
+  "author": {
+    "name": "Andrea Pontrandolfo",
+    "email": "[email protected]",
+    "url": "https://github.com/AndreaPontrandolfo"
   }
 }
diff --git a/packages/sheriff-create-config/src/utils/getEslintConfigRawText.ts b/packages/sheriff-create-config/src/utils/getEslintConfigRawText.ts
@@ -18,9 +18,8 @@ export const getEslintConfigRawText = async (
   }
 
   const eslintConfigRawText = {
-    ts: `import sheriff from 'eslint-config-sheriff';
+    ts: `import sheriff, { type SheriffSettings } from 'eslint-config-sheriff';
 import { defineFlatConfig } from 'eslint-define-config';
-import type { SheriffSettings } from '@sherifforg/types';
 
 const sheriffOptions: SheriffSettings = ${JSON.stringify(
       sheriffConfig,

diff --git a/packages/sheriff-create-config/src/utils/getRequiredPackages.ts b/packages/sheriff-create-config/src/utils/getRequiredPackages.ts
@@ -17,8 +17,6 @@ export const getRequiredPackages = (
   if (isEslintTsPatchRequired) {
     requiredPackages.push(`eslint-ts-patch`, `eslint@npm:eslint-ts-patch`);
     consola.start("Installing 'eslint-ts-patch'...");
-    requiredPackages.push('@sherifforg/types');
-    consola.start("Installing '@sherifforg/types'...");
   }
 
   return requiredPackages;

diff --git a/packages/sheriff-types/package.json b/packages/sheriff-types/package.json
@@ -1,28 +1,20 @@
 {
   "name": "@sherifforg/types",
   "description": "Sheriff types.",
-  "version": "4.1.1",
-  "license": "MIT",
   "type": "module",
-  "files": [
-    "dist"
-  ],
   "exports": {
-    ".": {
-      "import": "./dist/index.js"
-    }
+    ".": "./src/index.ts"
   },
+  "files": [
+    "src"
+  ],
   "scripts": {
     "clean": "rm -rf .turbo dist",
-    "typecheck": "tsc --noEmit",
-    "publint": "publint",
-    "build": "tsup"
+    "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
     "@types/node": "^22.5.1",
-    "publint": "^0.2.10",
     "tsconfig": "workspace:*",
-    "tsup": "^8.2.4",
     "typescript": "^5.5.3"
   },
   "repository": {
@@ -35,16 +27,6 @@
     "email": "[email protected]",
     "url": "https://github.com/AndreaPontrandolfo"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "bug": "https://github.com/AndreaPontrandolfo/sheriff/labels/bug",
-  "keywords": [
-    "javascript",
-    "eslint",
-    "typescript",
-    "types"
-  ],
   "engines": {
     "node": ">=20.10.0"
   }

diff --git a/packages/sheriff-types/tsconfig.json b/packages/sheriff-types/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "include": ["src"],
-  "exclude": ["dist", "build", "node_modules"],
+  "exclude": ["node_modules"],
   "extends": "tsconfig/base.json",
   "compilerOptions": {
     "module": "ESNext",

diff --git a/packages/sheriff-types/tsup.config.json b/packages/sheriff-types/tsup.config.json