You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
4
-
with multi-package repos, or single-package repos to help you version and publish your code. You can
5
-
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
3
+
Hello and welcome!
4
+
This folder has been automatically generated by `@changesets/cli`, a build tool that works with multi-package repos, or single-package repos to help you version and publish your code.
5
+
You can find the full documentation for it [in our repository](https://github.com/changesets/changesets)
6
6
7
-
We have a quick list of common questions to get you started engaging with this project in
We have a quick list of common questions to get you started engaging with this project in [our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|[`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 |[](https://www.npmjs.com/package/eslint-config-sheriff)|
19
-
|[`@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 |[](https://www.npmjs.com/package/@sherifforg/create-config)|
20
-
|[`@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 |[](https://www.npmjs.com/package/@sherifforg/cli)|
21
-
22
-
## 🚀 Getting Started
23
-
24
-
Visit the [official docs](https://www.eslint-config-sheriff.dev) to get started with Sheriff.
25
-
26
-
## 📝 Updates
27
-
28
-
You can follow the latest updates on the project in the [official blog](https://www.eslint-config-sheriff.dev/blog).
29
-
30
-
## 🧡 Contributing
31
-
32
-
### Suggestions
33
-
34
-
I consider Sheriff a community effort, and I welcome suggestions and contributions of any kind.
35
-
Feel free to propose suggestions about new rules to implement, or tweaks to existing rules.<br>
36
-
Please use the discussions tab or the issues tab for new rules proposals.
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.<br>
52
-
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`.<br>
53
-
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.<br>
54
-
The full list of the plugins used is [here](https://www.eslint-config-sheriff.dev/docs/eslint-plugins).
|[`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 |[](https://www.npmjs.com/package/eslint-config-sheriff)|
19
+
|[`@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 |[](https://www.npmjs.com/package/@sherifforg/create-config)|
20
+
|[`@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 |[](https://www.npmjs.com/package/@sherifforg/cli)|
21
+
22
+
## 🚀 Getting Started
23
+
24
+
Visit the [official docs](https://www.eslint-config-sheriff.dev) to get started with Sheriff.
25
+
26
+
## 📝 Updates
27
+
28
+
You can follow the latest updates on the project in the [official blog](https://www.eslint-config-sheriff.dev/blog).
29
+
30
+
## 🧡 Contributing
31
+
32
+
### Suggestions
33
+
34
+
I consider Sheriff a community effort, and I welcome suggestions and contributions of any kind.
35
+
Feel free to propose suggestions about new rules to implement, or tweaks to existing rules.<br />
36
+
Please use the discussions tab or the issues tab for new rules proposals.
37
+
38
+
### Development
39
+
40
+
1. Clone this repository (`git clone https://github.com/AndreaPontrandolfo/sheriff.git`)
41
+
1. Enable Corepack via `corepack enable`
42
+
1. Install the dependencies via `pnpm install`
43
+
1. Make, commit, push, and PR your changes
44
+
45
+
## 🌤 Changelog
46
+
47
+
See the [releases](https://github.com/AndreaPontrandolfo/sheriff/releases) page.
48
+
49
+
## 💌 Acknowledgments
50
+
51
+
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.<br />
52
+
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`.<br />
53
+
I don’t take any attribution for the rules in the various ESLint plugins used here (except for the few that I personally created).
54
+
Please consider starring the respective projects for the awesome work their authors made.
55
+
Sheriff wouldn’t be possible without their efforts.<br />
56
+
The full list of the plugins used is [here](https://www.eslint-config-sheriff.dev/docs/eslint-plugins).
Copy file name to clipboardexpand all lines: apps/docs-website/blog/2023-08-16-sheriff-reboot.mdx
+26-16
Original file line number
Diff line number
Diff line change
@@ -22,46 +22,56 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
22
22
## Sheriff release v14
23
23
24
24
Sheriff, the ESLint sharable config, has exciting news to share!<br />
25
-
With a complete rebranding, a restructured codebase, and exciting plans ahead, Sheriff is set to become an even more essential tool for ensuring code quality and consistency in projects.<br />
26
-
Let's walkthrough the key changes of this release.
25
+
With a complete rebranding, a restructured codebase, and exciting plans,
26
+
Sheriff is set to become an even more essential tool for ensuring code quality and consistency in projects.<br />
27
+
Let’s walkthrough the key changes of this release.
27
28
28
29
## Restructured Codebase in a monorepo
29
30
30
-
The codebase has been restructured into a monorepo setup with [Turborepo](https://turbo.build/repo) + [pnpm workspaces](https://pnpm.io/workspaces), as it allows for the management of multiple related packages under a single repository, streamlining the development process and enabling better coordination between different parts of the project.
31
-
32
-
As a side-effect, the project now relies on [changesets](https://github.com/changesets/changesets) to manage semantic versioning, in place of [semantic-release](https://github.com/semantic-release/semantic-release).
31
+
The codebase has been restructured into a monorepo with [Turborepo](https://turbo.build/repo) + [pnpm workspaces](https://pnpm.io/workspaces).
32
+
This allows for the management of multiple related packages under a single repository,
33
+
streamlining the development process and enabling better coordination between different parts of the project.
34
+
Also, the project now uses [changesets](https://github.com/changesets/changesets)
35
+
to manage semantic versioning in place of [semantic-release](https://github.com/semantic-release/semantic-release).
33
36
34
37
## Complete Rebranding
35
38
36
39
### New Docs
37
40
38
-
The documentation has been fully revamped, moving on from [Gitbook](https://www.gitbook.com/) to [Docusaurus](https://docusaurus.io/), a modern documentation framework.<br/>
39
-
Whether a newcomer or a seasoned user, the documentation is more accessible and easier to navigate, with a sidebar that allows for quick access to the different sections.<br/>
40
-
Also, a special [Rules page](https://www.eslint-config-sheriff.dev/docs/rules) was carefully crafted to let users explore in detail all the rules that Sheriff enables.
41
+
The documentation has been fully revamped, moving on from [GitBook](https://www.gitbook.com/) to [Docusaurus](https://docusaurus.io/), a modern documentation framework.<br/>
42
+
Whether a newcomer or a seasoned user, the documentation is more accessible and easier to navigate, with a sidebar that allows for quick access to the different sections.<br/>
43
+
Also, a special [rules page](https://www.eslint-config-sheriff.dev/docs/rules) was carefully crafted to let users explore all the rules that Sheriff enables in detail.
41
44
42
45
Visit the new docs at this [link](https://www.eslint-config-sheriff.dev).
43
46
44
47
### New Logo
45
48
46
-
The beginning of a fresh era for Sheriff is marked by a new logo, that features the iconic ESLint logo and a shield.
49
+
The beginning of a fresh era for Sheriff is marked by a new logo that features the iconic ESLint logo and a shield.
47
50
48
51
49
52
50
53
### New Blog
51
54
52
-
A [brand-new blog](https://www.eslint-config-sheriff.dev/blog) is now available, where I'll keep sharing updates on the projects as it grows along.
55
+
A [brand-new blog](https://www.eslint-config-sheriff.dev/blog) is now available,
56
+
where we will keep sharing updates as it continues to grow.
57
+
If you want, you can even [subscribe via RSS](https://www.eslint-config-sheriff.dev/)!
53
58
54
-
## What's Next
59
+
## What’s Next
55
60
56
-
The focus remains on continuously improving the tool, making it more adaptable, and responding to the evolving needs of the development community.<br />
61
+
The focus remains on continuous improvement,
62
+
making it more adaptable,
63
+
and responding to the evolving needs of the development community.<br />
57
64
Looking ahead, several exciting developments are in store:
58
65
59
-
-**Astro Support**: In the continuous effort to integrate more eslint-plugins into Sheriff, the next in line is [eslint-plugin-astro](https://github.com/ota-meshi/eslint-plugin-astro).
66
+
-**Astro Support**: In the continuous effort to integrate more ESLint plugins into Sheriff, the next in line is [eslint-plugin-astro](https://github.com/ota-meshi/eslint-plugin-astro).
60
67
-**Searchbar**: full-text search, powered by [Algolia](https://www.algolia.com/) in the new docs.
61
-
-**Ask AI**: along with the new searchbar will come an "Ask AI bot" feature. Details on this one are still being worked on.
68
+
-**Ask AI**: along with the new searchbar will come an “Ask AI bot” feature.
69
+
Details still being worked out.
62
70
63
71
## Conclusion
64
72
65
-
With this much-needed facelift, Sheriff is ready to keep growing. With a new documentation hub powered by Docusaurus, logo, and blog in place, Sheriff is set to provide an even more exceptional ESLint sharable config experience.<br/>
66
-
If you want to help feel free to propose new features, both for the config and the docs, or report any bug you might come across.<br/>
73
+
With this much-needed facelift, Sheriff is ready to keep growing.
74
+
With a new documentation hub powered by Docusaurus, logo, and blog in place,
75
+
Sheriff is set to provide an even more exceptional ESLint sharable config experience.<br />
76
+
If you want to help feel free to propose new features, both for the config and the docs, or report any bug you might come across.<br />
67
77
Stay tuned for updates and insights on the new blog!
0 commit comments