@shun-shobon/style-guide 0.1.0-next.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 NISHIZAWA Shuntaro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,53 @@
+# shun-shobon's Style Guide
+
+## Introduction
+
+This repository is a collection of style guides for web application development, which includes configs for popular tools linting and styling tools.
+
+The following configs are available:
+
+- [ESLint](#ESLint)
+- [Prettier](#Prettier)
+
+## Installation
+
+All of the configs are contained in one package, `@shun-shobon/style-guide`. To install:
+
+```bash
+# If you use npm
+npm install --save-dev @shun-shobon/style-guide
+
+# If you use yarn
+yarn add --save-dev @shun-shobon/style-guide
+
+# If you use pnpm
+pnpm add --dev @shun-shobon/style-guide
+```
+
+Some of the configs require peer dependencies.
+
+## ESLint
+
+> [!NOTE]
+> ESLint is a peer-dependency of this package, and should be installed at the root of your project.
+
+To use the shared ESLint config, set the following in `eslint.config.js`:
+
+```js
+import { shun_shobon } from "@shun-shobon/style-guide/eslint";
+
+export default shun_shobon();
+```
+
+## Prettier
+
+> [!NOTE]
+> Prettier is a peer-dependency of this package, and should be installed at the root of your project.
+
+To use the shared Prettier config, set the following in `prettier.config.js`:
+
+```js
+import { shun_shobon } from "@shun-shobon/style-guide/prettier";
+
+export default shun_shobon();
+```