Made most of the config packages public (#826)

souyahia-monk · web-flow · commit d6488d9bc68b · 2024-08-07T16:13:06.000+02:00
diff --git a/configs/eslint-config-base/package.json b/configs/eslint-config-base/package.json
@@ -4,7 +4,6 @@
   "version": "4.0.6",
   "description": "The base ESLint config used in MonkJs projects",
   "author": "monkvision",
-  "private": true,
   "main": "index.js",
   "license": "BSD-3-Clause-Clear",
   "files": [
diff --git a/configs/eslint-config-typescript-react-native/LICENSE b/configs/eslint-config-typescript-react-native/LICENSE
diff --git a/configs/eslint-config-typescript-react-native/README.md b/configs/eslint-config-typescript-react-native/README.md
diff --git a/configs/eslint-config-typescript-react-native/index.js b/configs/eslint-config-typescript-react-native/index.js
diff --git a/configs/eslint-config-typescript-react-native/package.json b/configs/eslint-config-typescript-react-native/package.json
diff --git a/configs/eslint-config-typescript-react/package.json b/configs/eslint-config-typescript-react/package.json
@@ -4,7 +4,6 @@
   "version": "4.0.6",
   "description": "The base ESLint config that used in MonkJs TypeScript React projects",
   "author": "monkvision",
-  "private": true,
   "main": "index.js",
   "license": "BSD-3-Clause-Clear",
   "files": [
diff --git a/configs/eslint-config-typescript/package.json b/configs/eslint-config-typescript/package.json
@@ -4,7 +4,6 @@
   "version": "4.0.6",
   "description": "The base ESLint config that used in MonkJs TypeScript projects",
   "author": "monkvision",
-  "private": true,
   "main": "index.js",
   "license": "BSD-3-Clause-Clear",
   "files": [
diff --git a/configs/jest-config/package.json b/configs/jest-config/package.json
@@ -4,7 +4,6 @@
   "version": "4.0.6",
   "description": "Jest configuration files used in MonkJs projects",
   "author": "monkvision",
-  "private": true,
   "main": "index.js",
   "license": "BSD-3-Clause-Clear",
   "files": [
diff --git a/configs/prettier-config/package.json b/configs/prettier-config/package.json
@@ -4,7 +4,6 @@
   "version": "4.0.6",
   "description": "The base Prettier config used in MonkJs projects",
   "author": "monkvision",
-  "private": true,
   "main": "index.js",
   "license": "BSD-3-Clause-Clear",
   "files": [
diff --git a/configs/test-utils/package.json b/configs/test-utils/package.json
@@ -5,7 +5,6 @@
   "packageManager": "yarn@3.2.4",
   "description": "MonkJs testing utilities",
   "author": "monkvision",
-  "private": true,
   "main": "index.ts",
   "files": [
     "package.json",
diff --git a/configs/typescript-config/README.md b/configs/typescript-config/README.md
@@ -41,4 +41,3 @@ Here is a list of available Typescript config files exported by this project :
 |------------------------------|----------------------------------------------|
 | `tsconfig.json`              | Base configuration for TypeScript projects   |
 | `tsconfig.react.json`        | Base configuration for React projects        |
-| `tsconfig.react-native.json` | Base configuration for React Native projects |
diff --git a/configs/typescript-config/package.json b/configs/typescript-config/package.json
@@ -4,7 +4,6 @@
   "version": "4.0.6",
   "description": "The TSConfigs used in MonkJs TypeScript projects",
   "author": "monkvision",
-  "private": true,
   "license": "BSD-3-Clause-Clear",
   "files": [
     "tsconfig.json",
diff --git a/configs/typescript-config/tsconfig.react-native.json b/configs/typescript-config/tsconfig.react-native.json
diff --git a/documentation/docs/local-development.md b/documentation/docs/local-development.md
@@ -0,0 +1,48 @@
+---
+sidebar_position: 9
+---
+
+# Local Development
+The [packages section](category/packages) only references the MonkJs packages used as main dependencies of Node
+apps, and necessary to develop a production app. But the MonkJs SDK contains a lot of other NPM packages that can be
+used as dev dependencies when developing your Node apps. These include packages like preferred linting rules, custom
+TypeScript configurations, testing utilities etc. Obviously, all of this is optional and just here to make your
+developer life a bit simpler if your code practices align with ours. As a matter of fact, the entire MonkJs SDK is being
+developed and maintained using these quality of life packages.
+
+If you plan on installing one of these local development packages in your project, just make sure to install the exact
+same version as the MonkJs version that you are currently using.
+
+## Linting
+The following packages export ESLint configurations that can extended, using the following syntax :
+
+```javascript
+module.exports = {
+  extends: ['@monkvision/eslint-config-base'],
+};
+```
+
+- [@monkvision/eslint-config-base](https://github.com/monkvision/monkjs/blob/main/configs/eslint-config-base/README.md) :
+  Base ESLint configuration used for any JavaScript-based project.
+- [@monkvision/eslint-config-typescript](https://github.com/monkvision/monkjs/blob/main/configs/eslint-config-typescript/README.md) :
+  ESLint configuration used for TypeScript project.
+- [@monkvision/eslint-config-typescript-react](https://github.com/monkvision/monkjs/blob/main/configs/eslint-config-typescript-react/README.md) :
+  ESLint configuration used for React projects based on TypeScript.
+
+## Project Configurations
+The following packages export shared configurations used to configure local development dependencies :
+
+- [@monkvision/jest-config](https://github.com/monkvision/monkjs/blob/main/configs/jest-config]/README.md) :
+  [Jest](https://jestjs.io/) configurations for unit testing.
+- [@monkvision/prettier-config](https://github.com/monkvision/monkjs/blob/main/configs/prettier-config]/README.md) :
+  [Prettier](https://prettier.io/) configurations for code formatting.
+- [@monkvision/svgo-config](https://github.com/monkvision/monkjs/blob/main/configs/svgo-config]/README.md) :
+  [SVGO](https://svgo.dev/) configurations for SVG linting.
+- [@monkvision/typescript-config](https://github.com/monkvision/monkjs/blob/main/configs/typescript-config]/README.md) :
+  Ready-to-use TypeScript config files.
+
+## Testing Utilities
+The MonkJs SDK also includes a testing utility package called
+[@monkvision/test-utils](https://github.com/monkvision/monkjs/blob/main/configs/test-utils]/README.md) that exports
+useful functions and tools used for unit testing.
+
diff --git a/documentation/docs/packages/_category_.json b/documentation/docs/packages/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Packages",
-  "position": 10,
+  "position": 11,
   "link": {
     "type": "generated-index",
     "description": "This page lists the NPM packages available in the MonkJs SDK."
diff --git a/documentation/docs/upgrading-from-v3.md b/documentation/docs/upgrading-from-v3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 9
+sidebar_position: 10
 ---
 
 # Upgrading From V3
diff --git a/documentation/docs/v3-docs/_category_.json b/documentation/docs/v3-docs/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "V3 Docs",
-  "position": 11,
+  "position": 12,
   "link": {
     "type": "doc",
     "id": "v3-docs/index"
diff --git a/yarn.lock b/yarn.lock
@@ -3670,18 +3670,6 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@monkvision/eslint-config-typescript-react-native@workspace:configs/eslint-config-typescript-react-native":
-  version: 0.0.0-use.local
-  resolution: "@monkvision/eslint-config-typescript-react-native@workspace:configs/eslint-config-typescript-react-native"
-  peerDependencies:
-    "@monkvision/eslint-config-typescript": "*"
-    eslint-plugin-jsx-a11y: ^6.7.1
-    eslint-plugin-react: ^7.27.1
-    eslint-plugin-react-hooks: ^4.3.0
-    eslint-plugin-react-native: ^4.0.4
-  languageName: unknown
-  linkType: soft
-
 "@monkvision/eslint-config-typescript-react@4.0.6, @monkvision/eslint-config-typescript-react@workspace:configs/eslint-config-typescript-react":
   version: 0.0.0-use.local
   resolution: "@monkvision/eslint-config-typescript-react@workspace:configs/eslint-config-typescript-react"
