@stryker-mutator/api/src/plugin/tokens.ts

The api for the extendable JavaScript mutation testing framework Stryker

/**
 * Define a string literal.
 * @param value Token literal
 */
function stringLiteral<T extends string>(value: T): T {
  return value;
}

const target: import('typed-inject').TargetToken = '$target';
const injector: import('typed-inject').InjectorToken = '$injector';

/**
 * Common tokens used for dependency injection (see typed-inject readme for more information)
 */
export const commonTokens = Object.freeze({
  getLogger: stringLiteral('getLogger'),
  injector,
  logger: stringLiteral('logger'),
  options: stringLiteral('options'),
  fileDescriptions: stringLiteral('fileDescriptions'),
  target,
});

/**
 * Helper method to create string literal tuple type.
 * @example
 * ```ts
 * const inject = tokens('foo', 'bar');
 * const inject2: ['foo', 'bar'] = ['foo', 'bar'];
 * ```
 * @param tokens The tokens as args
 */
export function tokens<TS extends string[]>(...tokensList: TS): TS {
  return tokensList;
}