codemod-cli/src/readme-support.js at 5658ea5b34c8533a073e03d0bb1f3edf74513e11 · rwjblue/codemod-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
'use strict';

const { stripIndent } = require('common-tags');

function projectReadme(projectName) {
  return stripIndent`
      # ${projectName}\n

      A collection of codemod's for ${projectName}.

      ## Usage

      To run a specific codemod from this project, you would run the following:

      \`\`\`
      npx ${projectName} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js

      # or

      yarn global add ${projectName}
      ${projectName} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
      \`\`\`

      ## Transforms

      <!--TRANSFORMS_START-->
      <!--TRANSFORMS_END-->

      ## Contributing

      ### Installation

      * clone the repo
      * change into the repo directory
      * \`yarn\`

      ### Running tests

      * \`yarn test\`

      ### Update Documentation

      * \`yarn update-docs\`
    `;
}

function codemodReadme(projectName, codemodName) {
  return stripIndent`
    # ${codemodName}\n

    ## Usage

    \`\`\`
    npx ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js

    # or

    yarn global add ${projectName}
    ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
    \`\`\`

    ## Input / Output

    <!--FIXTURES_TOC_START-->
    <!--FIXTURES_TOC_END-->

    <!--FIXTURES_CONTENT_START-->
    <!--FIXTURES_CONTENT_END-->
  `;
}

module.exports = {
  codemodReadme,
  projectReadme,
};