feat: introduce library configs with instructions

Author: rozsival

packages/lint-staged-config/README.md

@@ -34,6 +34,14 @@ Then, create a `lint-staged.config.js` file in each workspace:
 export { workspace as default } from '@apitree.cz/lint-staged-config';
 ```
 
+If the workspace contains a distributable package (aka library), use the following configuration instead:
+
+```js
+export { library as default } from '@apitree.cz/lint-staged-config';
+```
+
+> See the [WebStorm Settings in PNPM Monorepos](../ts-config/README.md#webstorm-settings-in-pnpm-monorepos) section in `@apitree.cz/ts-config` for further information.
+
 ### Single-package repos
 
 Install the package and create a `lint-staged.config.js` file in the root of your project:

packages/lint-staged-config/src/index.ts

@@ -1,3 +1,4 @@
+export * from './library.js';
 export * from './root.js';
 export * from './single-package.js';
 export * from './workspace.js';

packages/lint-staged-config/src/library.ts

@@ -0,0 +1,11 @@
+import type { Configuration } from 'lint-staged';
+
+import { workspace } from './workspace.js';
+
+/**
+ * Lint-staged configuration for monorepo workspace containing distributable library.
+ */
+export const library = {
+  ...workspace,
+  './**/*.{ts,tsx}': [() => 'tsc --build tsconfig.lib.json'],
+} satisfies Configuration;

packages/ts-config/README.md

@@ -63,6 +63,46 @@ Suitable for distributable `npm` packages (framework-agnostic).
 }
 ```
 
+#### WebStorm Settings in PNPM Monorepos
+
+In order for WebStorm to correctly resolve paths for internal packages in PNPM monorepos, separate your configuration into:
+
+`tsconfig.lib.json`
+
+```json
+{
+  "extends": "@apitree.cz/ts-config/library",
+  "include": ["**/*.js", "**/*.ts", "**/*.tsx"],
+  "exclude": ["dist", "node_modules"]
+}
+```
+
+`tsconfig.json`
+
+```json
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}
+```
+
+> 🧠 Do not forget to use the `tsconfig.lib.json` in your general type-check script.
+
+If your package also contains other non-src files (e.g. `tests`, `scripts`, etc.), create a separate `tsconfig.json` in each of those folders:
+
+```json
+{
+  "extends": "../tsconfig.lib.json",
+  "compilerOptions": {
+    "rootDir": ".."
+  }
+}
+```
+
 ### Node.js
 
 Suitable for Node.js services and apps.