fix(prettier-plugin-jsdoc): move app into fns

homer0 · Oct 29, 2020 · 86e8ba8 · 86e8ba8
1 parent d5c7e85
commit 86e8ba8
Show file tree

Hide file tree

Showing 32 changed files with 38 additions and 38 deletions.
diff --git a/src/app.js → src/fns/app.js b/src/app.js → src/fns/app.js
diff --git a/src/fns/constants.js b/src/fns/constants.js
@@ -1,4 +1,4 @@
-const { provider } = require('../app');
+const { provider } = require('./app');
 
 /**
  * Gets a dictionary where the keys are old tags' names, and values the current tag name for which

diff --git a/src/fns/formatAccessTag.js b/src/fns/formatAccessTag.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { findTagIndex } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PJPAccessTagOptions} PJPAccessTagOptions

diff --git a/src/fns/formatArrays.js b/src/fns/formatArrays.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { isMatch, replaceDotOnTypeGeneric } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 /**
  * @typedef {import('../types').PJPTypesOptions} PJPTypesOptions
  */

diff --git a/src/fns/formatDescription.js b/src/fns/formatDescription.js
@@ -4,7 +4,7 @@ const {
   joinIfNotEmpty,
   appendIfNotPresent,
 } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PJPDescriptionTagOptions} PJPDescriptionTagOptions

diff --git a/src/fns/formatObjects.js b/src/fns/formatObjects.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { isMatch, replaceDotOnTypeGeneric } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PJPTypesOptions} PJPTypesOptions

diff --git a/src/fns/formatStringLiterals.js b/src/fns/formatStringLiterals.js
@@ -1,5 +1,5 @@
 const R = require('ramda');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PJPTypesOptions} PJPTypesOptions

diff --git a/src/fns/formatTSTypes.js b/src/fns/formatTSTypes.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { capitalize, ensureArray } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * Utility function generated by {@link getFormater} and that can be used to modify a type name.

diff --git a/src/fns/formatTags.js b/src/fns/formatTags.js
@@ -4,7 +4,7 @@ const { replaceTagsSynonyms } = require('./replaceTagsSynonyms');
 const { sortTags } = require('./sortTags');
 const { trimTagsProperties } = require('./trimTagsProperties');
 const { formatTagsDescription } = require('./formatTagsDescription');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/formatTagsDescription.js b/src/fns/formatTagsDescription.js
@@ -1,7 +1,7 @@
 const R = require('ramda');
 const { getTagsWithDescriptionAsName, getTagsWithNameAsDescription } = require('./constants');
 const { isTag, hasValidProperty } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/formatTagsTypes.js b/src/fns/formatTagsTypes.js
@@ -5,7 +5,7 @@ const { formatStringLiterals } = require('./formatStringLiterals');
 const { formatArrays } = require('./formatArrays');
 const { formatObjects } = require('./formatObjects');
 const { formatTypeAsCode } = require('./formatTypeAsCode');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PJPTypesOptions} PJPTypesOptions

diff --git a/src/fns/formatTypeAsCode.js b/src/fns/formatTypeAsCode.js
@@ -1,7 +1,7 @@
 const { format } = require('prettier');
 const R = require('ramda');
 const { isMatch } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PrettierOptions} PrettierOptions

diff --git a/src/fns/getLanguages.js b/src/fns/getLanguages.js
@@ -2,7 +2,7 @@ const jsLang = require('linguist-languages/data/JavaScript.json');
 const jsxLang = require('linguist-languages/data/JSX.json');
 const tsLang = require('linguist-languages/data/TypeScript.json');
 const tsxLang = require('linguist-languages/data/TSX.json');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {LinguistLanguageProperties & LanguageSharedProperties} LinguistLanguage

diff --git a/src/fns/getOptions.js b/src/fns/getOptions.js
@@ -1,4 +1,4 @@
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PrettierSupportOption} PrettierSupportOption

diff --git a/src/fns/getParsers.js b/src/fns/getParsers.js
@@ -9,7 +9,7 @@ const { formatTags } = require('./formatTags');
 const { formatTagsTypes } = require('./formatTagsTypes');
 const { prepareTags } = require('./prepareTags');
 const { render } = require('./render');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 /**
  * @typedef {import('../types').PrettierParser} PrettierParser
  * @typedef {import('../types').PrettierParseFn} PrettierParseFn

diff --git a/src/fns/getPlugin.js b/src/fns/getPlugin.js
@@ -1,7 +1,7 @@
 const { getLanguages } = require('./getLanguages');
 const { getParsers } = require('./getParsers');
 const { getOptions, getDefaultOptions } = require('./getOptions');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PrettierSupportOption} PrettierSupportOption

diff --git a/src/fns/prepareExampleTag.js b/src/fns/prepareExampleTag.js
@@ -1,7 +1,7 @@
 const { format } = require('prettier');
 const R = require('ramda');
 const { isTag, prefixLines, splitLinesAndClean } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PrettierOptions} PrettierOptions

diff --git a/src/fns/prepareTagDescription.js b/src/fns/prepareTagDescription.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { ensureSentence, hasValidProperty, isTag } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/prepareTagName.js b/src/fns/prepareTagName.js
@@ -1,5 +1,5 @@
 const R = require('ramda');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/prepareTags.js b/src/fns/prepareTags.js
@@ -2,7 +2,7 @@ const R = require('ramda');
 const { prepareExampleTag } = require('./prepareExampleTag');
 const { prepareTagDescription } = require('./prepareTagDescription');
 const { prepareTagName } = require('./prepareTagName');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PrettierOptions} PrettierOptions

diff --git a/src/fns/render.js b/src/fns/render.js
@@ -5,7 +5,7 @@ const { renderExampleTag } = require('./renderExampleTag');
 const { renderTagInLine } = require('./renderTagInLine');
 const { renderTagInColumns } = require('./renderTagInColumns');
 const { getTagsWithNameAsDescription } = require('./constants');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentBlock} CommentBlock

diff --git a/src/fns/renderExampleTag.js b/src/fns/renderExampleTag.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { splitText } = require('./splitText');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').PrettierOptions} PrettierOptions

diff --git a/src/fns/renderTagInColumns.js b/src/fns/renderTagInColumns.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { splitText } = require('./splitText');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/renderTagInLine.js b/src/fns/renderTagInLine.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { splitText } = require('./splitText');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/replaceTagsSynonyms.js b/src/fns/replaceTagsSynonyms.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { getTagsSynonyms } = require('./constants');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/sortTags.js b/src/fns/sortTags.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { getIndexOrFallback } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/splitText.js b/src/fns/splitText.js
@@ -1,6 +1,6 @@
 const R = require('ramda');
 const { ensureArray, replaceLastItem, limitAdjacentRepetitions } = require('./utils');
-const { get, provider } = require('../app');
+const { get, provider } = require('./app');
 
 /**
  * This is used when splitting lines that contain linebreaks; it's used as a filter so a text won't

diff --git a/src/fns/trimTagsProperties.js b/src/fns/trimTagsProperties.js
@@ -1,4 +1,4 @@
-const { provider } = require('../app');
+const { provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/fns/utils.js b/src/fns/utils.js
@@ -1,5 +1,5 @@
 const R = require('ramda');
-const { provider } = require('../app');
+const { provider } = require('./app');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag

diff --git a/src/index.js b/src/index.js
@@ -1,5 +1,5 @@
 const path = require('path');
-const { loadProviders, get } = require('./app');
+const { loadProviders, get } = require('./fns/app');
 const { getPlugin } = require('./fns/getPlugin');
 
 loadProviders(path.join(__dirname, 'fns'), [

diff --git a/test/unit/app.test.js → test/unit/fns/app.test.js b/test/unit/app.test.js → test/unit/fns/app.test.js
@@ -1,8 +1,8 @@
-jest.unmock('../../src/app');
-jest.mock('../../src/fns/sortTags', () => ({
+jest.unmock('../../../src/fns/app');
+jest.mock('../../../src/fns/sortTags', () => ({
   provider: jest.fn(),
 }));
-jest.mock('../../src/fns/splitText', () => ({
+jest.mock('../../../src/fns/splitText', () => ({
   provider: jest.fn(),
 }));
 
@@ -15,10 +15,10 @@ const {
   registerModule,
   provider,
   loadProviders,
-} = require('../../src/app');
+} = require('../../../src/fns/app');
 
-const { provider: sortTagsProvider } = require('../../src/fns/sortTags');
-const { provider: splitTextProvider } = require('../../src/fns/splitText');
+const { provider: sortTagsProvider } = require('../../../src/fns/sortTags');
+const { provider: splitTextProvider } = require('../../../src/fns/splitText');
 
 describe('app', () => {
   beforeEach(() => {
@@ -127,7 +127,7 @@ describe('app', () => {
 
   it('should load and execute the providers of a list of modules', () => {
     // Given
-    const directory = path.join(__dirname, '..', '..', 'src', 'fns');
+    const directory = path.join(__dirname, '..', '..', '..', 'src', 'fns');
     const mods = ['sortTags', 'splitText'];
     // When
     loadProviders(directory, mods);

diff --git a/test/unit/index.test.js b/test/unit/index.test.js
@@ -1,8 +1,8 @@
 jest.unmock('../../src/index');
-jest.mock('../../src/app');
+jest.mock('../../src/fns/app');
 
 const path = require('path');
-const { loadProviders, get } = require('../../src/app');
+const { loadProviders, get } = require('../../src/fns/app');
 const { getPlugin } = require('../../src/fns/getPlugin');
 
 describe('plugin', () => {