https://github.com/thepassle/module-utils

https://github.com/thepassle/module-utils

Last synced: about 7 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/thepassle/module-utils
• Owner: thepassle
• Created: 2024-03-07T09:07:44.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-14T16:50:00.000Z (8 months ago)
• Last Synced: 2024-10-23T15:36:27.167Z (21 days ago)
• Language: JavaScript
• Size: 39.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# module-utils

## `analyze`

Convenience function to easily analyze source code

```js

import { analyze } from '@thepassle/module-utils';

let hasVariables = false;

analyze(source, filePath, [

  {

    name: "analyze-exports",

    start: ({ ts, source, filePath, ast, context }) => {},

    analyze: ({ ts, node, source, filePath, ast, context }) => {

      if (ts.isVariableDeclaration(node)) {

        hasVariables = true;

      }

    },

    end: ({ ts, source, filePath, ast, context }) => {},

  }

]);

hasVariables; // true

```

## `imports`/`exports`

Analyzes import and export statements in the code.

```js

import { imports } from '@thepassle/module-utils/imports.js';

const [result] = imports('import foo from "./foo.js";', 'file.js');

console.log(result);

// {

//   kind: 'default',

//   name: 'foo',

//   declaration: 'foo',

//   module: 'foo.js',

//   isTypeOnly: false,

//   attributes: []

// }

```

```js

import { exports } from '@thepassle/module-utils/exports.js';

const [result] = exports('export default foo;', 'file.js');

console.log(result);

// {

//   kind: 'js',

//   name: 'default',

//   declaration: {

//     module: 'file.js',

//     name: 'foo'

//   }

// }

```

See the test cases for all supported import/exports.

### Limitations of dynamic imports

For dynamic imports we only resolve the symbol name for the following cases:

```js

const foo = await import('bar');

const [ foo ] = await import('bar');

const [ foo, ...bar ] = await import('bar');

const { foo } = await import('bar');

const { foo, ...bar } = await import('bar');

const { foo: baz } = await import('bar');

```

Additionally, imports with dynamic values will be output as follows:

```js

const bar = 'bar';

import('./foo-' + bar + '.js');

// "./foo-*.js"

import(`./foo-${bar}.js`);

// "./foo-*.js"

```

And imports with only identifiers are skipped:

```js

import(foo);

```

## Barrel files

```js

import { barrelFile } from '@thepassle/module-utils/barrel-file.js';

const source = `

  export {foo} from 'foo';

  export {bar} from 'bar';

  export {baz} from 'baz';

`;

const result = barrelFile(source, 'file.js', {amountOfExportsToConsiderModuleAsBarrel: 2});

console.log(result); // true

```

## Utils

```js

import {

  has,

  toUnix,

  isBareModuleSpecifier,

  isScopedPackage

} from '@thepassle/module-utils/utils.js';

```