Skip to content

Commit

Permalink
Made most of the config packages public
Browse files Browse the repository at this point in the history
  • Loading branch information
souyahia-monk committed Aug 7, 2024
1 parent 58246b4 commit dc649ff
Show file tree
Hide file tree
Showing 18 changed files with 51 additions and 212 deletions.
1 change: 0 additions & 1 deletion configs/eslint-config-base/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
32 changes: 0 additions & 32 deletions configs/eslint-config-typescript-react-native/LICENSE

This file was deleted.

61 changes: 0 additions & 61 deletions configs/eslint-config-typescript-react-native/README.md

This file was deleted.

19 changes: 0 additions & 19 deletions configs/eslint-config-typescript-react-native/index.js

This file was deleted.

47 changes: 0 additions & 47 deletions configs/eslint-config-typescript-react-native/package.json

This file was deleted.

1 change: 0 additions & 1 deletion configs/eslint-config-typescript-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
1 change: 0 additions & 1 deletion configs/eslint-config-typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
1 change: 0 additions & 1 deletion configs/jest-config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
1 change: 0 additions & 1 deletion configs/prettier-config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
1 change: 0 additions & 1 deletion configs/test-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"packageManager": "[email protected]",
"description": "MonkJs testing utilities",
"author": "monkvision",
"private": true,
"main": "index.ts",
"files": [
"package.json",
Expand Down
1 change: 0 additions & 1 deletion configs/typescript-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
1 change: 0 additions & 1 deletion configs/typescript-config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
30 changes: 0 additions & 30 deletions configs/typescript-config/tsconfig.react-native.json

This file was deleted.

48 changes: 48 additions & 0 deletions documentation/docs/local-development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 9
---

# Local Development
The [packages section](docs/category/packages.md) 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.

2 changes: 1 addition & 1 deletion documentation/docs/packages/_category_.json
Original file line number Diff line number Diff line change
@@ -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."
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/upgrading-from-v3.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 9
sidebar_position: 10
---

# Upgrading From V3
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/v3-docs/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "V3 Docs",
"position": 11,
"position": 12,
"link": {
"type": "doc",
"id": "v3-docs/index"
Expand Down
12 changes: 0 additions & 12 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected], @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"
Expand Down

0 comments on commit dc649ff

Please sign in to comment.