@ankhorage/devtools 1.0.0 → 1.0.1

package/README.md

@@ -1,78 +1,63 @@
-# @ankhorage/devtools
+# devtools
 
-Shared Lint and Format Configuration for Ankhorage.
+Shared ESLint and Prettier configuration for modern TypeScript projects.
 
-This package provides a unified, modern ESLint and Prettier configuration policy used across Ankhorage projects. It is built on top of **ESLint Flat Config** and **typescript-eslint**, ensuring a seamless, type-safe development experience.
+## What you get
+- Consistent linting across repos
+- Zero-config Prettier setup
+- Strict TypeScript rules without compromise
+- One source of truth for tooling
+
+## Features
+- Flat ESLint config (latest standard)
+- Preconfigured plugin ecosystem
+- Prettier integration
+- Monorepo-friendly
 
 ## Installation
 
 ```bash
-bun add -d @ankhorage/devtools
-# or
-npm install --save-dev @ankhorage/devtools
+bun add -D @ankhorage/devtools
 ```
 
-## Features
-
-- **One Package, Two Exports**: Access everything via `@ankhorage/devtools/eslint` and `@ankhorage/devtools/prettier`.
-- **Modern Standards**: Built for ESLint 9+ and Prettier 3+.
-- **Type-Safe**: Uses `typescript-eslint`'s recommended type-checked and stylistic rules.
-- **Unified Policy**: Converges all repositories to a single, high-quality linting standard.
-
 ## Usage
 
 ### ESLint
 
-Create an `eslint.config.mjs` file in your project root:
-
-```javascript
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { createConfig } from '@ankhorage/devtools/eslint';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
+```js
+import config from '@ankhorage/devtools/eslint'
 
-export default createConfig({
-  tsconfigRootDir: __dirname,
-  project: ['./tsconfig.json'],
-  files: ['src/**/*.ts'],
-});
+export default config()
 ```
 
-#### Configuration Options
-
-The `createConfig` function accepts the following required options:
-
-- `tsconfigRootDir`: The root directory for tsconfig resolution (typically `import.meta.dirname` or equivalent).
-- `project`: An array of paths to your `tsconfig` files (e.g., `['./tsconfig.json']`).
-- `files`: An array of glob patterns for the files you want to lint (e.g., `['src/**/*.{ts,tsx}']`).
-
-Optional options:
-
-- `allowDefaultProject`: Glob patterns for files to allow in the default project.
-- `additionalIgnores`: Extra glob patterns to ignore.
-- `restrictedImports`: An array of `{ name, message }` objects to append to the default restricted imports.
-- `overrides`: An array of raw ESLint flat config objects to append to the configuration.
-- `includePrettier`: Whether to include the Prettier configuration (defaults to `true`).
-
 ### Prettier
 
-Create a `prettier.config.cjs` file in your project root:
-
-```javascript
-/** @type {import('prettier').Config} */
-module.exports = require('@ankhorage/devtools/prettier');
+```json
+{
+  "extends": "@ankhorage/devtools/prettier"
+}
 ```
 
-**Note**: You should keep a local `.prettierignore` file in your repository to define ignored patterns.
+## Use Cases
+- Monorepos with shared standards
+- Teams that want strict, predictable linting
+- Projects avoiding duplicated config
+
+## Why this exists
 
-## Examples
+Maintaining ESLint + Prettier configs across multiple repositories leads to:
+- duplication
+- inconsistency
+- drift over time
 
-Check the [examples](./examples) directory for copy-pasteable configurations:
+This package centralizes tooling so all projects stay aligned.
 
-- `examples/monorepo/eslint.config.mjs`: For monorepo project structures.
-- `examples/package/eslint.config.mjs`: For standalone package structures.
+## Scope
 
-## License
+Includes:
+- ESLint configuration
+- Prettier configuration
 
-MIT
+Excludes:
+- runtime code
+- build tooling

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/devtools",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Shared Lint and Format Configuration for Ankhorage",
   "type": "module",
   "publishConfig": {