Miss any of our Open RFC calls?Watch the recordings here! »

import-resolver

0.2.0 • Public • Published

importResolver

The goal of this project is to allow you to freely reorganize your code without worrying about the relative paths in all your import/require statments

This utility will examine all your import/require statements, identifying which are broken. It will attempt to fix any broken paths by using the algorithm specified in the configuration file.

Recommended Reorganization Steps:

  1. Reorganize your entire folder structure in a way that makes sense - including folder renaming (but don't rename files here)
  2. Commit.
  3. Run this tool to fix all the broken references. It will print out any that it was confused about so you know which ones to manually check/fix.
  4. Commit.
  5. Rename any files as needed - using your editors search & replace features to fix any require/import statements
  6. Commit.
  7. Celebrate

Installation

npm install import-resolver

Run

node importResolver [--dryRun] [<customConfigFile>]

Configuration

You will want a configuration file to customize the behaviour. It will look for the default configuration file of importResolver.json. You can also specify one on the command line: node importResolver customConfigFile.json. If no config file is found or specified, defaults will be used.

Default Configuration:

{
    fileTypes: [ ".js", ".jsx" ],
    missingExtensions: [ ".js", ".jsx" ],
    exclude: [ ".git", "node_modules", "coverage" ],
    requireGitClean: false,
    resolveAlgo: "first",
}
  • fileTypes: file types to examine
  • missingExtensions: file extensions that are omitted from require/import statements
  • exclude: folders to exclude/ignore
  • requireGitClean: require git status to be clean before making changes
  • resolveAlgo: an algorithm to use for resolving cases where a file requires/imports '../a/b/index' and there are 2+ index.js files in the tree. This is the algorithm used to pick the right one. One of:
    • closest: picks the closest - fewest directory traversals (up or down)
    • minDistance: uses an edit-distance algorithm

TODO

Plans for future:

  • More testing in the real world
  • More FP-centric
  • Look at Madge for examples of how to use AST - to allow for files to be renamed as well - and give tons of other flexibility and options.
  • Maybe use this as a better option for import-resolving in VSCode?

Node compatibility

Works on node 6.13 and above.

Licence

Apache 2

Install

npm i import-resolver

DownloadsWeekly Downloads

3

Version

0.2.0

License

Apache-2.0

Unpacked Size

71.4 kB

Total Files

24

Last publish

Collaborators

  • avatar