moroshko/ react-scanner

(0.6.0) 7 months ago

usage

JavaScript

jsx

abstract-syntax-tree

React

View on GitHub

Need help with react-scanner?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

moroshko

142 Stars

6 Forks

MIT License

70 Commits

4 Opened issues

Description

Extract React components and props usage from code.

Services available

Need anything else?

Contributors list

Misha Moroshko moroshko

# 5,470

React

Babel

TypeScr...

reasonm...

27 commits

WhiteSource Renovate renovate-bot

# 92

netlify

TypeScr...

GraphQL

angular...

20 commits

Douglas Eggleton douglaseggleton

# 172,645

TypeScr...

apollo-...

GraphQL

React

1 commit

Readme

react-scanner

Name: react-scanner
Brand: react-scanner
SKU: //moroshko/react-scanner
Rating: 2.105 (142 reviews)

react-scanner

statically analyzes the given code (TypeScript supported) and extracts React components and props usage.

First, it crawls the given directory and compiles a list of files to be scanned. Then, it scans every file and extracts rendered components and their props into a JSON report.

For example, let's say we have the following

index.js

file:

import React from "react";
import ReactDOM from "react-dom";
import {
  BasisProvider,
  defaultTheme,
  Container,
  Text,
  Link as BasisLink,
} from "basis";

function App() {
  return (
    
      
        
          Want to know how your design system components are being used?
        
        
          Try{" "}
          
            react-scanner
          
        
      
    
  );
}
ReactDOM.render(, document.getElementById("root"));

Running

react-scanner

on it will create the following JSON report:

Click to see it

{
  "BasisProvider": {
    "instances": [
      {
        "importInfo": {
          "imported": "BasisProvider",
          "local": "BasisProvider",
          "moduleName": "basis"
        },
        "props": {
          "theme": "(Identifier)"
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/index.js",
          "start": {
            "line": 13,
            "column": 5
          }
        }
      }
    ]
  },
  "Container": {
    "instances": [
      {
        "importInfo": {
          "imported": "Container",
          "local": "Container",
          "moduleName": "basis"
        },
        "props": {
          "margin": "4",
          "hasBreakpointWidth": null
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/index.js",
          "start": {
            "line": 14,
            "column": 7
          }
        }
      }
    ]
  },
  "Text": {
    "instances": [
      {
        "importInfo": {
          "imported": "Text",
          "local": "Text",
          "moduleName": "basis"
        },
        "props": {
          "textStyle": "subtitle2"
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/index.js",
          "start": {
            "line": 15,
            "column": 9
          }
        }
      },
      {
        "importInfo": {
          "imported": "Text",
          "local": "Text",
          "moduleName": "basis"
        },
        "props": {
          "margin": "4 0 0 0"
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/index.js",
          "start": {
            "line": 18,
            "column": 9
          }
        }
      }
    ]
  },
  "Link": {
    "instances": [
      {
        "importInfo": {
          "imported": "Link",
          "local": "BasisLink",
          "moduleName": "basis"
        },
        "props": {
          "href": "https://github.com/moroshko/react-scanner",
          "newTab": null
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/index.js",
          "start": {
            "line": 20,
            "column": 11
          }
        }
      }
    ]
  }
}

This raw JSON report is used then to generate something that is useful to you. For example, you might want to know:

How often a cetrain component is used in your design system? (see
```
count-components
```
processor)
How often a certain prop in a given component is used? (see
```
count-components-and-props
```
processor)
Looking at some prop in a given component, what's the distribution of values used? (e.g. you might consider deprecating a certain value)

Once you have the result you are interested in, you can write it to a file or simply log it to the console.

Installation

npm install --save-dev react-scanner

Usage

npx react-scanner -c /path/to/react-scanner.config.js

Config file

Everything that

react-scanner

does is controlled by a config file.

The config file can be located anywhere and it must export an object like this:

module.exports = {
  crawlFrom: "./src",
  includeSubComponents: true,
  importedFrom: "basis",
};

Running

react-scanner

with this config would output something like this to the console:

{
  "Text": {
    "instances": 17,
    "props": {
      "margin": 6,
      "color": 4,
      "textStyle": 1
    }
  },
  "Button": {
    "instances": 10,
    "props": {
      "width": 10,
      "variant": 5,
      "type": 3
    }
  },
  "Footer": {
    "instances": 1,
    "props": {}
  }
}

Here are all the available config options:

| Option | Type | Description | | ---------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

crawlFrom

| string | The path of the directory to start crawling from.
Absolute or relative to the config file location. | |

exclude

| array or function | Each array item should be a string or a regex. When crawling, if directory name matches exactly the string item or matches the regex item, it will be excluded from crawling.
For more complex scenarios,

exclude

can be a a function that accepts a directory name and should return

true

if the directory should be excluded from crawling. | |

globs

| array | Only files matching these globs will be scanned. See here for glob syntax.
Default:

["**/!(*.test\|*.spec)[email protected](js\|ts)?(x)"]

| |

components

| object | Components to report. Omit to report all components. | |

includeSubComponents

| boolean | Whether to report subcomponents or not.
When

false

Footer

will be reported, but

Footer.Content

will not.
When

true

Footer.Content

will be reported, as well as

Footer.Content.Legal

, etc.
Default:

false

| |

importedFrom

| string or regex | Before reporting a component, we'll check if it's imported from a module name matching

importedFrom

and, only if there is a match, the component will be reported.
When omitted, this check is bypassed. | |

getComponentName

| function | This function is called to determine the component name to be used in report based on the

import

declaration.
Default:

({ imported, local, moduleName }) => imported || local

| |

processors

| array | See Processors.
Default:

["count-components-and-props"]

Processors

Scanning the files results in a JSON report. Add processors to tell

react-scanner

what to do with this report.

Built-in processors

react-scanner

comes with some ready to use processors.

To use a built-in processor, simply specify its name as a string, e.g.:

processors: ["count-components"]

You can also use a tuple form to pass options to a built-in processor, e.g.:

processors: [
  ["count-components", { outputTo: "/path/to/my-report.json" }]
]

All the built-in processors support the following options:

| Option | Type | Description | | ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- | |

outputTo

| string | Where to output the result.
Absolute or relative to the config file location.
When omitted, the result is printed out to the console. |

Here are the built-in processors that

react-scanner

comes with:

count-components

Example output:

{
  "Text": 10,
  "Button": 5,
  "Link": 3
}

count-components-and-props

Example output:

{
  "Text": {
    "instances": 17,
    "props": {
      "margin": 6,
      "color": 4,
      "textStyle": 1
    }
  },
  "Button": {
    "instances": 10,
    "props": {
      "width": 10,
      "variant": 4,
      "type": 2
    }
  },
  "Footer": {
    "instances": 1,
    "props": {}
  }
}

raw-report

Example output:

{
  "Text": {
    "instances": [
      {
        "props": {
          "textStyle": "subtitle2"
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/file",
          "start": {
            "line": 9,
            "column": 9
          }
        }
      },
      {
        "props": {
          "margin": "4 0 0 0"
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/file",
          "start": {
            "line": 12,
            "column": 9
          }
        }
      }
    ]
  },
  "Link": {
    "instances": [
      {
        "props": {
          "href": "https://github.com/moroshko/react-scanner",
          "newTab": null
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/file",
          "start": {
            "line": 14,
            "column": 11
          }
        }
      }
    ]
  },
  "Container": {
    "instances": [
      {
        "props": {
          "margin": "4",
          "hasBreakpointWidth": null
        },
        "propsSpread": false,
        "location": {
          "file": "/path/to/file",
          "start": {
            "line": 8,
            "column": 7
          }
        }
      }
    ]
  }
}

Custom processors

We saw above that built-in processors come in the form of a string or a tuple.

Custom processors are functions, and can be asynchronous!

If the processor function returns a

Promise

, it will be awaited before the next processor kicks in. This way, you can use previous processors results in your processor function.

Here is an example of taking the output of the built-in

count-components-and-props

processor and sending it to your storage solution.

processors: [
  "count-components-and-props",
  ({ prevResult }) => {
    return axios.post("/my/storage/solution", prevResult);
  }
]

Processor functions receive an object with the following keys in it:

| Key | Type | Description | | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

report

| object | The raw JSON report. | |

prevResults

| array | Previous processors results. | |

prevResult

| any | The last item in

prevResults

. Just for convenience. | |

forEachComponent

| function | Helper function to recursively traverse the raw JSON report. The function you pass in is called for every component in the report, and it gets an object with

componentName

and

component

in it. Check the implementation of

count-components-and-props

for a usage example. | |

sortObjectKeysByValue

| function | Helper function that sorts object keys by some function of the value. Check the implementation of

count-components-and-props

for a usage example. | |

output

| function | Helper function that outputs the given data. Its first parameter is the data you want to output. The second parameter is the destination. When the second parameter is omitted, it outputs to the console. To output to the file system, pass an absolute path or a relative path to the config file location. |

License

MIT