thepassle / module-utils

module-utils

analyze

Convenience function to easily analyze source code

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.

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: []
// }

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:

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:

const bar = 'bar';
import('./foo-' + bar + '.js');
// "./foo-*.js"

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

And imports with only identifiers are skipped:

import(foo);

Barrel files

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

import {
  has,
  toUnix,
  isBareModuleSpecifier,
  isScopedPackage
} from '@thepassle/module-utils/utils.js';