forked from facebook/react-native
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
RN: Enforce Manifest Constraints w/ ESLint
Summary: Creates a new lint rule that enforces the following constraints: - `react-native/monorepo` cannot have `dependencies`. - `react-native` cannot have `devDependencies`. This also includes a lengthy comment in the rule definition explaining why these constraints exist, so that future contributors can make an informed decision when reconsidering these constraints. Changelog: [Internal] Differential Revision: D48448633 fbshipit-source-id: 841f42df52c8d516a068e4acbbb611c3aa0369e9
- Loading branch information
1 parent
9f47b6a
commit 3654c98
Showing
6 changed files
with
211 additions
and
2 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 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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "name": "@react-native/eslint", | ||
| "private": true, | ||
| "version": "0.0.0", | ||
| "dependencies": { | ||
| "jsonc-eslint-parser": "^2.3.0" | ||
| } | ||
| } |
91 changes: 91 additions & 0 deletions
91
tools/eslint/rules/__tests__/react-native-manifest-test.js
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,91 @@ | ||
| /** | ||
| * Copyright (c) Meta Platforms, Inc. and affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @format | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const rule = require('../react-native-manifest.js'); | ||
| const {RuleTester} = require('eslint'); | ||
|
|
||
| const ruleTester = new RuleTester({ | ||
| parser: require.resolve('jsonc-eslint-parser'), | ||
| }); | ||
|
|
||
| ruleTester.run('react-native-manifest', rule, { | ||
| valid: [ | ||
| { | ||
| code: JSON.stringify({ | ||
| name: '@react-native/package-name', | ||
| }), | ||
| }, | ||
| { | ||
| code: JSON.stringify({ | ||
| name: '@react-native/package-name', | ||
| dependencies: { | ||
| dependencyA: '1.0.0', | ||
| }, | ||
| devDependencies: { | ||
| dependencyB: '1.0.0', | ||
| }, | ||
| }), | ||
| }, | ||
| { | ||
| code: JSON.stringify({ | ||
| name: '@react-native/monorepo', | ||
| devDependencies: { | ||
| dependencyB: '1.0.0', | ||
| }, | ||
| }), | ||
| }, | ||
| { | ||
| code: JSON.stringify({ | ||
| name: 'react-native', | ||
| dependencies: { | ||
| dependencyA: '1.0.0', | ||
| }, | ||
| }), | ||
| }, | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: JSON.stringify({ | ||
| name: '@react-native/monorepo', | ||
| dependencies: { | ||
| dependencyA: '1.0.0', | ||
| }, | ||
| }), | ||
| errors: [ | ||
| { | ||
| messageId: 'propertyDisallowed', | ||
| data: { | ||
| property: 'dependencies', | ||
| describe: | ||
| "Declare 'dependencies' in `packages/react-native/package.json`.", | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| code: JSON.stringify({ | ||
| name: 'react-native', | ||
| devDependencies: { | ||
| dependencyA: '1.0.0', | ||
| }, | ||
| }), | ||
| errors: [ | ||
| { | ||
| messageId: 'propertyDisallowed', | ||
| data: { | ||
| property: 'devDependencies', | ||
| describe: "Declare 'devDependencies' in `<root>/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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /** | ||
| * Copyright (c) Meta Platforms, Inc. and affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @format | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| /** | ||
| * React Native's monorepo requires that "devDependencies" be declared at the | ||
| * root package.json and "dependencies" in the `react-native` package.json to | ||
| * permit the ability to segment dependent workspaces into 1) a development | ||
| * workspace root (which depends on the monorepo) and 2) a production workspace | ||
| * (which depends on the `react-native` package). | ||
| */ | ||
| const PACKAGE_CONSTRAINTS = { | ||
| '@react-native/monorepo': { | ||
| disallowed: [ | ||
| { | ||
| property: 'dependencies', | ||
| describe: | ||
| "Declare 'dependencies' in `packages/react-native/package.json`.", | ||
| }, | ||
| ], | ||
| }, | ||
| 'react-native': { | ||
| disallowed: [ | ||
| { | ||
| property: 'devDependencies', | ||
| describe: "Declare 'devDependencies' in `<root>/package.json`.", | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| type: 'problem', | ||
| docs: { | ||
| description: 'Enforce react-native manifest constraints', | ||
| }, | ||
| messages: { | ||
| propertyDisallowed: | ||
| "'{{property}}' is disallowed in this file. {{describe}}", | ||
| }, | ||
| schema: [], | ||
| }, | ||
|
|
||
| create(context) { | ||
| // @see https://www.npmjs.com/package/jsonc-eslint-parser | ||
| if (!context.parserServices.isJSON) { | ||
| return {}; | ||
| } | ||
| return { | ||
| 'JSONExpressionStatement > JSONObjectExpression'(node) { | ||
| const propertyNodes = {}; | ||
| for (const propertyNode of node.properties) { | ||
| propertyNodes[propertyNode.key.value] = propertyNode; | ||
| } | ||
|
|
||
| const name = propertyNodes.name?.value?.value; | ||
| const constraints = PACKAGE_CONSTRAINTS[name]; | ||
| if (constraints == null) { | ||
| return; | ||
| } | ||
|
|
||
| for (const {property, describe} of constraints.disallowed) { | ||
| const propertyNode = propertyNodes[property]; | ||
| if (propertyNode == null) { | ||
| continue; | ||
| } | ||
| context.report({ | ||
| node: propertyNode, | ||
| messageId: 'propertyDisallowed', | ||
| data: {property, describe}, | ||
| }); | ||
| } | ||
| }, | ||
| }; | ||
| }, | ||
| }; |
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