diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
index 7faf3e75..11c995cc 100644
--- a/.github/ISSUE_TEMPLATE/feature.yml
+++ b/.github/ISSUE_TEMPLATE/feature.yml
@@ -41,11 +41,11 @@ body:
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/AndreaPontrandolfo/sheriff/blob/master/CODE_OF_CONDUCT.md)
required: true
- - label: I have read the [Contributing Guidelines on Pull Requests](https://github.com/AndreaPontrandolfo/sheriff/blob/master/CONTRIBUTING.md#opening-a-new-pull-request).
+ - label: I have read the [Contributing Guidelines on Issues](https://github.com/AndreaPontrandolfo/sheriff/blob/master/CONTRIBUTING.md#opening-a-new-issue).
required: true
- type: checkboxes
attributes:
label: I will submit a PR
- description: If you are willing to submit a PR to fix this issue, please check the box below.
+ description: If you are willing to submit a PR to do this feature, please check the box below.
options:
- label: I'd be willing to submit a PR for this issue.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..6c9d454e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+
+
+
+## Related Issue
+
+
+
+
+
+
+Closes #
+
+## Other
+
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md.BACKUP b/.github/PULL_REQUEST_TEMPLATE.md.BACKUP
deleted file mode 100644
index de24bc4f..00000000
--- a/.github/PULL_REQUEST_TEMPLATE.md.BACKUP
+++ /dev/null
@@ -1,44 +0,0 @@
-
-
-## Description
-
-
-
-## Related Issue
-
-
-
-
-
-
-## Motivation and Context
-
-
-
-## How Has This Been Tested?
-
-
-
-
-
-## Screenshots (if appropriate):
-
-## Types of changes
-
-
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
-
-## Checklist:
-
-
-
-
-- [ ] My code follows the code style of this project.
-- [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
-- [ ] I have read the **CONTRIBUTING** document.
-- [ ] I have added tests to cover my changes.
-- [ ] All new and existing tests passed.
diff --git a/README.md b/README.md
index 2ceb495e..c4fbca10 100755
--- a/README.md
+++ b/README.md
@@ -26,17 +26,26 @@ This repository is a monorepo that hosts the sourcecode of the following project
| [`@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?color=1A786D)](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?color=1A786D)](https://www.npmjs.com/package/@sherifforg/cli) |
-## 🚀 Getting Started
+## 🚀 Quickstart
-Visit the [official docs](https://www.eslint-config-sheriff.dev) to get started with Sheriff.
+```bash
+npm init @sherifforg/config
+```
-## 📝 Updates
+## 📋 Docs
+
+Visit the [official docs](https://www.eslint-config-sheriff.dev/docs/introduction) to learn more.
+
+## 📝 Blog
You can follow the latest updates on the project in the [official blog](https://www.eslint-config-sheriff.dev/blog).
## 💌 Acknowledgments
-For some of this configuration, [eslint-config-red](https://github.com/GrosSacASac/JavaScript-Set-Up/blob/master/js/red-javascript-style-guide/index.js) was partially used as a base.
-Additionally, inspiration was drawn from [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) for some of the rules in `no-restricted-syntax`.
-I don't take any attribution for the rules in the various eslint-plugins used here (except for the few that I personally created). Please consider starring the respective projects for the awesome work their authors made. Sheriff wouldn't be possible without their efforts.
-The full list of the plugins used is [here](https://www.eslint-config-sheriff.dev/docs/eslint-plugins).
+For some of this configuration, [eslint-config-red](https://github.com/GrosSacASac/JavaScript-Set-Up/blob/master/js/red-javascript-style-guide/index.js) was partially used as a base. Additionally, inspiration was drawn from [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) for some of the rules in `no-restricted-syntax`.
+
+I don't take any attribution for the rules in the various eslint-plugins used here (except for the few that I personally created).
+
+Please consider starring the respective projects for the awesome work their authors made. Sheriff wouldn't be possible without their efforts.
+
+[Full list of the plugins integrated in Sheriff](https://www.eslint-config-sheriff.dev/docs/eslint-plugins).
diff --git a/apps/docs-website/docs/usage-in-ci.md b/apps/docs-website/docs/usage-in-ci.md
index b58c5f5b..44d8babd 100644
--- a/apps/docs-website/docs/usage-in-ci.md
+++ b/apps/docs-website/docs/usage-in-ci.md
@@ -31,7 +31,7 @@ npm run sheriff
## How it works
-The `sheriff` command will scan your project dependencies and your Sheriff configuration object. If Sheriff finds some dependencies that don't have the corresponding Sheriff option enabled, it will throw an error.
+The `sheriff` command will scan your project dependencies and your Sheriff configuration object. If Sheriff finds some dependencies that don't have the corresponding Sheriff options enabled, it will throw an error.
Example:
diff --git a/packages/eslint-config-sheriff/package.json b/packages/eslint-config-sheriff/package.json
index 44abd1b5..31fab6b4 100644
--- a/packages/eslint-config-sheriff/package.json
+++ b/packages/eslint-config-sheriff/package.json
@@ -55,7 +55,6 @@
"publint": "publint"
},
"dependencies": {
- "@arethetypeswrong/cli": "^0.17.2",
"@eslint-react/eslint-plugin": "^1.10.1",
"@eslint/compat": "^1.2.4",
"@eslint/js": "^9.17.0",
@@ -97,6 +96,7 @@
},
"license": "MIT",
"devDependencies": {
+ "@arethetypeswrong/cli": "^0.17.2",
"@sherifforg/constants": "workspace:*",
"@sherifforg/types": "workspace:*",
"@types/confusing-browser-globals": "^1.0.3",
diff --git a/packages/eslint-config-sheriff/tsup.config.js b/packages/eslint-config-sheriff/tsup.config.js
index 3b7c800d..b3bf0f41 100644
--- a/packages/eslint-config-sheriff/tsup.config.js
+++ b/packages/eslint-config-sheriff/tsup.config.js
@@ -8,7 +8,7 @@ export default defineConfig({
clean: true,
noExternal: ['@sherifforg/constants', '@sherifforg/types'],
skipNodeModulesBundle: true,
- dts: { entry: 'src/index.ts' },
+ dts: { entry: 'src/index.ts' /* ,resolve: true */ },
// banner: ({ format }) => {
// return format === 'esm'
// ? {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index a06dddda..945b0f3d 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -357,9 +357,6 @@ importers:
packages/eslint-config-sheriff:
dependencies:
- '@arethetypeswrong/cli':
- specifier: ^0.17.2
- version: 0.17.2
'@eslint-react/eslint-plugin':
specifier: ^1.10.1
version: 1.21.0(eslint@9.17.0(jiti@2.4.2))(typescript@5.7.2)
@@ -454,6 +451,9 @@ importers:
specifier: ^8.15.0
version: 8.18.1(eslint@9.17.0(jiti@2.4.2))(typescript@5.7.2)
devDependencies:
+ '@arethetypeswrong/cli':
+ specifier: ^0.17.2
+ version: 0.17.2
'@sherifforg/constants':
specifier: workspace:*
version: link:../sheriff-constants