Git Product home page Git Product logo

barrel-finder's Introduction

NodeJS script that find imports from barrel in each Typescript file

Usage

  • npm i
  • node barrel-finder "<GLOBLIKE_PATH_TO_START>" "<GLOBLIKE_MASK_TO_IGNORE>"
  • Example node barrel-finder "../libs/**/*.ts" "../libs/**/*.index.ts"
  • Note! path should be wrapped into quotes

Description

Script will parse only typescript files, so you should provide path like this: ../../libs/**/*.ts (glob-like path)

In program you may see this line: const source = program.getSourceFile(file);

  • source is for SourceFileObject object (from Typescript API) that include Map called resolveModules.
  • resolveModules contains metadata about each module (file that you imported)
  • Example import without barrel:
    {
        resolveModules: {
            key: './simple-request.dto',
            value: {
                originalPath: undefined, 
                extension: '.ts', 
                isExternalLibraryImport: false, 
                packageId: undefined,
                resolvedFileName: '/path/to/libs/http-lib/data/requests/simple-request.dto.ts', 
            }
        } as Map<string, any>
    }
  • Example import WITH barrel:
    {
        resolveModules: {
            key: '../requests',
            value: {
                originalPath: undefined, 
                extension: '.ts', 
                isExternalLibraryImport: false, 
                packageId: undefined,
                resolvedFileName: '/path/to/libs/http-lib/data/requests/index.ts', // This is our barrel file, we can use it for mark
            }
        } as Map<string, any>
    }

Use cases

If you develop some angular libraries with ng-packagr you may got a looooot of errors when you using barrel files. This script will help you to find imports from barrels!

barrel-finder's People

Contributors

alxpsr avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.