-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Made most of the config packages public
- Loading branch information
1 parent
58246b4
commit dc649ff
Showing
18 changed files
with
51 additions
and
212 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
47 changes: 0 additions & 47 deletions
47
configs/eslint-config-typescript-react-native/package.json
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,6 @@ | |
"packageManager": "[email protected]", | ||
"description": "MonkJs testing utilities", | ||
"author": "monkvision", | ||
"private": true, | ||
"main": "index.ts", | ||
"files": [ | ||
"package.json", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 9 | ||
sidebar_position: 10 | ||
--- | ||
|
||
# Upgrading From V3 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
|