Merge pull request #42 from fingerprintjs/polish-packages

Add info about packages to the readme, polish packages

Author: ilfa

.changeset/four-rockets-brake.md

@@ -0,0 +1,6 @@
+---
+'@fingerprintjs/prettier-config-dx-team': minor
+---
+
+- update usage example in the readme
+- add prettier package as a dependency

.changeset/sweet-comics-invite.md

@@ -0,0 +1,6 @@
+---
+'@fingerprintjs/eslint-config-dx-team': minor
+---
+
+- update usage example in the readme
+- add eslint and and eslint packages as a dependencies

.prettierrc

@@ -0,0 +1 @@
+"@fingerprintjs/prettier-config-dx-team"

README.md

@@ -3,6 +3,31 @@
 > **Note**
 > This repository isn’t part of our core product. It’s kindly shared “as-is” without any guaranteed level of support from Fingerprint. We warmly welcome community contributions.
 
+## Reusable configurations
+
+This monorepo stores reusable configurations for tools like ESLint, Prettier, etc. used by the DX team at Fingerprint.
+
+1. Eslint: [@fingerprintjs/eslint-config-dx-team](packages/eslint-config-dx-team)
+<a href="https://www.npmjs.com/package/@fingerprintjs/eslint-config-dx-team">
+   <img src="https://img.shields.io/npm/v/@fingerprintjs/eslint-config-dx-team.svg" alt="Current NPM version @fingerprintjs/eslint-config-dx-team">
+</a>
+2. Prettier: [@fingerprintjs/prettier-config-dx-team](packages/prettier-config-dx-team)
+<a href="https://www.npmjs.com/package/@fingerprintjs/prettier-config-dx-team">
+   <img src="https://img.shields.io/npm/v/@fingerprintjs/prettier-config-dx-team.svg" alt="Current NPM version @fingerprintjs/prettier-config-dx-team">
+</a>
+3. Typescript: [@fingerprintjs/tsconfig-dx-team](packages/tsconfig-dx-team)
+<a href="https://www.npmjs.com/package/@fingerprintjs/tsconfig-dx-team">
+  <img src="https://img.shields.io/npm/v/@fingerprintjs/tsconfig-dx-team.svg" alt="Current NPM version @fingerprintjs/tsconfig-dx-team">
+</a>
+4. Convectional Commits: [@fingerprintjs/commit-lint-dx-team](packages/commit-lint-dx-team)
+<a href="https://www.npmjs.com/package/@fingerprintjs/commit-lint-dx-team">
+  <img src="https://img.shields.io/npm/v/@fingerprintjs/commit-lint-dx-team.svg" alt="Current NPM version @fingerprintjs/commit-lint-dx-team">
+</a>
+5. Commits Analyzer: [@fingerprintjs/conventional-changelog-dx-team](packages/conventional-changelog-dx-team)
+<a href="https://www.npmjs.com/package/@fingerprintjs/conventional-changelog-dx-team">
+  <img src="https://img.shields.io/npm/v/@fingerprintjs/conventional-changelog-dx-team.svg" alt="Current NPM version @fingerprintjs/conventional-changelog-dx-team">
+</a>
+
 ## Reusable workflows
 
 * [1. Run tests and show coverage diff](#1-run-tests-and-show-coverage-diff)

packages/eslint-config-dx-team/README.md

@@ -19,11 +19,21 @@ To use this preset in your project, add the following configuration to your proj
 
 ```js
 module.exports = {
-  extends: ['@fingerprintjs/eslint-dx-team'],
+  extends: ['@fingerprintjs/eslint-config-dx-team'],
 }
-
 ```
 
+## Dependencies
+
+To simplify dependencies update in project this package has eslint and eslint packages as a dependencies.
+Please don't add any of them as a dependencies for you project:
+
+- `@typescript-eslint/eslint-plugin`
+- `@typescript-eslint/parser`
+- `eslint`
+- `eslint-config-prettier`
+- `eslint-plugin-prettier`
+
 ## License
 
 This project is licensed under the MIT license. See

packages/eslint-config-dx-team/package.json

@@ -13,12 +13,14 @@
   "files": [
     "index.js"
   ],
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "6.19.1",
+    "@typescript-eslint/parser": "6.19.1",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3"
+  },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
-    "eslint": ">=8",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-prettier": "^4.2.1",
     "prettier": ">=3"
   }
 }

packages/prettier-config-dx-team/README.md

@@ -17,13 +17,15 @@ pnpm install @fingerprintjs/prettier-config-dx-team
 
 To use this preset in your project, add the following configuration to your project's prettier configuration file:
 
-```js
-module.exports = {
-  extends: ['@fingerprintjs/prettier-dx-team'],
-}
-
+```json
+"@fingerprintjs/prettier-config-dx-team"
 ```
 
+## Dependencies
+
+To simplify dependencies update in project this package has prettier package as a dependency.
+Please don't add it as a dependency for you project.
+
 ## License
 
 This project is licensed under the MIT license. See

packages/prettier-config-dx-team/package.json

@@ -13,7 +13,7 @@
   "files": [
     "index.js"
   ],
-  "peerDependencies": {
-    "prettier": ">=2"
+  "dependencies": {
+    "prettier": "3.2.4"
   }
 }