@eslint/config-inspector - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

dist/nitro.json

 {
-  "date": "2024-03-29T21:01:30.622Z",
+  "date": "2024-03-29T21:55:15.927Z",
   "preset": "node-server",
@@ -4,0 +4,0 @@ "framework": {

dist/public/_nuxt/builds/latest.json

@@ -1,1 +0,1 @@
-{"id":"bbb6c863-c321-4b41-b731-ed5777fd6402","timestamp":1711746082903}
+{"id":"69436321-2868-4449-9438-714268bb667f","timestamp":1711749308524}

package.json

 {
   "name": "@eslint/config-inspector",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "packageManager": "pnpm@8.15.5",
-  "description": "A visual tool to help you view and understand your ESLint Flat config",
+  "description": "A visual tool for inspecting and understanding your ESLint flat configs",
   "license": "Apache-2.0",
@@ -15,3 +15,6 @@ "funding": "https://opencollective.com/eslint",
   "bugs": "https://github.com/eslint/config-inspector/issues",
-  "bin": "./bin.mjs",
+  "bin": {
+    "@eslint/config-inspector": "./bin.mjs",
+    "eslint-config-inspector": "./bin.mjs"
+  },
   "files": [
@@ -18,0 +21,0 @@ "*.mjs",

README.md

@@ -8,10 +8,10 @@ <img src="./public/favicon.svg" width="100" height="100"><br>
 
-A visual tool to help you view and understand your [ESLint Flat configs](https://eslint.org/docs/latest/use/configure/configuration-files-new).
+A visual tool for inspecting and understanding your [ESLint flat configs](https://eslint.org/docs/latest/use/configure/configuration-files-new).
 
-<img width="1199" alt="Screenshot" src="https://github.com/antfu/eslint-flat-config-viewer/assets/11247099/f386563a-c655-458e-a2c3-0af19ebec958">
-<img width="1199" alt="Screenshot" src="https://github.com/antfu/eslint-flat-config-viewer/assets/11247099/44edeb05-02b3-4bca-8da6-768984e8d829">
+<img width="1230" alt="Screenshot 1" src="https://github.com/eslint/config-inspector/assets/11247099/b3cbdd57-9374-4905-bfdc-cdd40646b747">
+<img width="1458" alt="Screenshot 2" src="https://github.com/eslint/config-inspector/assets/11247099/d008bf61-3685-4bf5-843f-524beb108305">
 
 ## Usage
 
-Change the directory to your project root that contains `eslint.config.js` and run:
+Go to the project root that contains `eslint.config.js` and run:
 
@@ -22,10 +22,35 @@ ```bash
 
-Goto http://localhost:7777/ to view your ESLint config. Whenever you update your ESLint config, the page will be updated automatically.
+Visit http://localhost:7777/ to view and play with your ESLint config. Changes to the config file will be updated automatically.
 
----
+### Online Preview
 
-Or play it in your browser:
+Or play it right in your browser now:
 
 [![](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/eslint/config-inspector)
 
+## Contributing
+
+We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/config-inspector/issues).
+
+### Development
+
+This project uses the following stack:
+
+- [pnpm](https://pnpm.io/) for package management
+- [Nuxt](https://nuxt.com/) & [Vue](https://vuejs.org) for the app
+  - APIs are served under `server/api` powered by [Nitro](https://nitro.unjs.io/)
+- [UnoCSS](https://unocss.dev/) for styling
+  - With [attributify mode](https://unocss.dev/presets/attributify) enabled
+- Use [ESLint](https://eslint.org/) for linting and formatting
+
+To start the development server:
+
+- Install dependencies via `pnpm install` (we highly recommend you to [enable `corepack enable`](https://nodejs.org/api/corepack.html) first)
+- Run `pnpm dev` to start the development server at http://localhost:3000
+
+To test the production build:
+
+- Run `pnpm build` to build the app
+- Run `pnpm start` to start the production server at http://localhost:7777
+
 ## License
@@ -32,0 +57,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1682627

increased by0.09%

Number of lines in readme file

64

increased by64.1%

No dependency changes