@symbolism/cli

symbolism

Typescript symbol inspection/assertion tools.

npm install -g @symbolism/cli
symbolism --help

Features

Call static argument resolution (beta)

Document all of the inputs to a function. Evaluates the function call hierarchy and resolves all of the static arguments.

symbolism callInputs ./packages/test/src/dump-symbol.ts Schema

Code use test coverage

Ensure that critical code in your project has test coverage based on what is is rather than where it is. Test all of your analytics calls, critical API usage, etc. without resorting to requiring 100% coverage.

symbolism coverage

Output for defineSymbol.

defineSymbol: 85.19% covered (23/27)
  Missing:
    defineSymbol: ./packages/definitions/src/class.ts:33:14
    defineSymbol: ./packages/definitions/src/index.ts:166:12
    defineSymbol: ./packages/definitions/src/jsx.ts:17:12
    defineSymbol: ./packages/definitions/src/jsx.ts:23:12

See config section below for setup details.

Static schema extraction

Document the schema of your typescript data types. Calculates the final schema for your data types, merged interfaces.

symbolism dumpSchema ./packages/test/src/dump-symbol.ts Schema

Output:

{
  bar: "bar" | "bat";
  merged: number;
};

For a machine JSON Schema readable format, use the --json flag.

Config

WIP

{
  "tokens": [
    "function-call",
    "function-call-with-args",
    { "name": "myOtherFunction", "min": 0.9 }
  ],
  "min": 1
}

• tokens: A list of tokens to assert coverage for. Objects may be used to override the default config for those tokens. Any top-level config value may be set here.
• min: [0-1] The minimum percentage of token references required for the assertion to pass.

https://github.com/facebook/jest/issues/11188