major: v6 of parse-function

[tunnckoCore]

• fix Next Major: Simplifying the API, docs and the plugins, smaller codebase, TypeScript support #65
• require Node.js >=10.13
• License change! (Parity-7.0.0 AND Prosperity-2.0.0) OR Patron-1.0.0 or Private
  • see Licensing Plan #60
• exports named function
  • esm: import { parseFunction } from 'parse-function';
  • browser/deno: import { parseFunction } from 'https://unpkg.com/parse-function';
  • cjs: const { parseFunction } = require('parse-function');
• simplified API
• basic TypeScript support

Example

import { parse as acornParse } from 'acorn';
import { parseExpression } from '@babel/parser';
import { parseFunction } from '.';

function fooFn(bar, baz = 123) {
  return bar * baz;
}

// `node` is an AST Node
function bobbyPlugin(node, result) {
  const bobby = 'bobby';

  return { ...result, bobby };
}

function barryPlugin(node, result) {
  const hasDefaultParams =
    Object.values(result.defaults).filter(Boolean).length > 0;

  return { ...result, barry: 'barry barry', hasDefaultParams };
}

const result = parseFunction(fooFn, {
  parse: acornParse,
  plugins: [bobbyPlugin, barryPlugin],
  parserOptions: {},
});

console.log(result);

/* {
  name: 'fooFn',
  body: '\n  return bar * baz;\n',
  args: [ 'bar', 'baz' ],
  params: 'bar, baz',
  defaults: { bar: undefined, baz: '123' },
  value: '(function fooFn(bar, baz = 123) {\n  return bar * baz;\n})',
  isValid: true,
  isArrow: false,
  isAsync: false,
  isNamed: true,
  isAnonymous: false,
  isGenerator: false,
  isExpression: false,
  bobby: 'bobby',
  barry: 'barry barry',
  hasDefaultParams: true
} */

const res = parseFunction(fooFn, {
  parseExpression,
  parserOptions: {
    sourceType: 'module',
    allowAwaitOutsideFunction: true,
    allowReturnOutsideFunction: true,
  },
});
console.log(res);

Basic TypeScript typings

import { ParserOptions } from '@babel/parser';
import { File } from '@babel/types';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FnType = (...args: any) => any;

export type Input = FnType | string;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type Plugin = (node: any, result: Result) => Result | undefined;
export type Plugins = Plugin | Array<Plugin>;

export interface Options {
  parse?(input: string, options?: ParserOptions): File;
  parseExpression?(input: string, options?: ParserOptions): File;
  parserOptions?: ParserOptions;
  plugins?: Plugins;
}

export interface Result {
  name: string | null;
  body: string;
  args: Array<string>;
  params: string;
  defaults: { [key: string]: string | undefined };
  value: string;
  isValid: boolean;
  isArrow: boolean;
  isAsync: boolean;
  isNamed: boolean;
  isAnonymous: boolean;
  isGenerator: boolean;
  isExpression: boolean;
}

export function parseFunction(code: Input, options?: Options): Result;

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.47%. Comparing base (6fbf37b) to head (ea4e8d5).
⚠️ Report is 323 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #72      +/-   ##
==========================================
- Coverage   48.91%   48.47%   -0.44%     
==========================================
  Files          26       26              
  Lines         828      821       -7     
  Branches      253      254       +1     
==========================================
- Hits          405      398       -7     
  Misses        334      334              
  Partials       89       89              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[tunnckoCore]

TODO:

• update tests links in readme
• add note for v6 too

[tunnckoCore]

Why there is 2 PRs #67?! 🤔 🤣 I'm picking up this one, because it seems 5 days more recent, and is no TypeScript - it's simply separated on index.d.ts