Clean references to @providesModule (jestjs#7147)

rickhanlonii · Oct 12, 2018 · 9918cac · 9918cac
1 parent fbd66d3
commit 9918cac
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -51,6 +51,7 @@
 - `[*]` Bump dated dependencies ([#6978](https://github.com/facebook/jest/pull/6978))
 - `[scripts]` Don’t make empty subfolders for ignored files in build folder ([#7001](https://github.com/facebook/jest/pull/7001))
 - `[docs]` Add missing export statement in `puppeteer_environment.js` under `docs/Puppeteer.md` ([#7127](https://github.com/facebook/jest/pull/7127))
+- `[docs]` Remove references to `@providesModule` which isn't supported anymore ([#7147](https://github.com/facebook/jest/pull/7147))
 
 ## 23.6.0
 

diff --git a/docs/TutorialReactNative.md b/docs/TutorialReactNative.md
@@ -200,22 +200,3 @@ jest.mock('Text', () => {
 In other cases you may want to mock a native module that isn't a React component. The same technique can be applied. We recommend inspecting the native module's source code and logging the module when running a react native app on a real device and then modeling a manual mock after the real module.
 
 If you end up mocking the same modules over and over it is recommended to define these mocks in a separate file and add it to the list of `setupFiles`.
-
-### `@providesModule`
-
-If you'd like to use Facebook's `@providesModule` module system through an npm package, the default haste config option must be overwritten and npm modules must be added to `providesModuleNodeModules`:
-
-```json
-"haste": {
-  "defaultPlatform": "ios",
-  "platforms": ["android", "ios"],
-  "providesModuleNodeModules": [
-    "react",
-    "react-native",
-    "my-awesome-module",
-    "my-text-component"
-  ]
-},
-```
-
-If you'd like to test a different default platform or if you are building for other platforms, the `defaultPlatform` and `platforms` configuration option can be updated.
diff --git a/packages/jest-docblock/src/__tests__/index.test.js b/packages/jest-docblock/src/__tests__/index.test.js
@@ -18,7 +18,7 @@ describe('docblock', () => {
     const code =
       '/**' +
       os.EOL +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '* // TODO: test' +
       os.EOL +
@@ -28,7 +28,7 @@ describe('docblock', () => {
     expect(docblock.extract(code)).toBe(
       '/**' +
         os.EOL +
-        ' * @providesModule foo' +
+        ' * @team foo' +
         os.EOL +
         '* // TODO: test' +
         os.EOL +
@@ -40,43 +40,43 @@ describe('docblock', () => {
     const code =
       '/**' +
       os.EOL +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '*/' +
       os.EOL +
       'const x = foo;';
     expect(docblock.extract(code)).toBe(
-      '/**' + os.EOL + ' * @providesModule foo' + os.EOL + '*/',
+      '/**' + os.EOL + ' * @team foo' + os.EOL + '*/',
     );
   });
 
   it('extracts valid docblock with more comments', () => {
     const code =
       '/**' +
       os.EOL +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '*/' +
       os.EOL +
       'const x = foo;' +
       os.EOL +
       '/**foo*/';
     expect(docblock.extract(code)).toBe(
-      '/**' + os.EOL + ' * @providesModule foo' + os.EOL + '*/',
+      '/**' + os.EOL + ' * @team foo' + os.EOL + '*/',
     );
   });
 
   it('extracts from invalid docblock', () => {
     const code =
       '/*' +
       os.EOL +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '*/' +
       os.EOL +
       'const x = foo;';
     expect(docblock.extract(code)).toBe(
-      '/*' + os.EOL + ' * @providesModule foo' + os.EOL + '*/',
+      '/*' + os.EOL + ' * @team foo' + os.EOL + '*/',
     );
   });
 
@@ -102,7 +102,7 @@ describe('docblock', () => {
       '/**' +
       os.EOL +
       '' +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '' +
       ' * @css a b' +
@@ -115,7 +115,7 @@ describe('docblock', () => {
     expect(docblock.parse(code)).toEqual({
       css: 'a b',
       'preserve-whitespace': '',
-      providesModule: 'foo',
+      team: 'foo',
     });
   });
 
@@ -168,7 +168,7 @@ describe('docblock', () => {
       ' * Copyright 2004-present Facebook. All Rights Reserved.' +
       os.EOL +
       '' +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '' +
       ' * @css a b' +
@@ -187,7 +187,7 @@ describe('docblock', () => {
     expect(docblock.parse(code)).toEqual({
       css: 'a b',
       'preserve-whitespace': '',
-      providesModule: 'foo',
+      team: 'foo',
     });
   });
 
@@ -196,7 +196,7 @@ describe('docblock', () => {
       '/**' +
       os.EOL +
       '' +
-      ' * @providesModule foo' +
+      ' * @team foo' +
       os.EOL +
       '' +
       ' * // TODO: test' +
@@ -205,7 +205,7 @@ describe('docblock', () => {
       ' */';
     expect(docblock.parseWithComments(code)).toEqual({
       comments: '// TODO: test',
-      pragmas: {providesModule: 'foo'},
+      pragmas: {team: 'foo'},
     });
   });
 
@@ -283,17 +283,11 @@ describe('docblock', () => {
     });
   });
 
-  it('supports slashes in @providesModule directive', () => {
+  it('supports slashes in @team directive', () => {
     const code =
-      '/**' +
-      os.EOL +
-      '' +
-      ' * @providesModule apple/banana' +
-      os.EOL +
-      '' +
-      ' */';
+      '/**' + os.EOL + '' + ' * @team apple/banana' + os.EOL + '' + ' */';
     expect(docblock.parse(code)).toEqual({
-      providesModule: 'apple/banana',
+      team: 'apple/banana',
     });
   });
 
@@ -456,14 +450,14 @@ describe('docblock', () => {
   it('prints docblocks with pragmas', () => {
     const pragmas = {
       flow: 'foo',
-      providesModule: 'x/y/z',
+      team: 'x/y/z',
     };
     expect(docblock.print({pragmas})).toEqual(
       '/**' +
         os.EOL +
         ' * @flow foo' +
         os.EOL +
-        ' * @providesModule x/y/z' +
+        ' * @team x/y/z' +
         os.EOL +
         ' */',
     );