# @ef-carbon/tspm > A simple TypeScript document object model Latest version **2.2.5** (published 2018-08-28) · MIT license · 0 weekly downloads ## Install ```sh npm install @ef-carbon/tspm pnpm add @ef-carbon/tspm yarn add @ef-carbon/tspm bun add @ef-carbon/tspm ``` Provides the command `ef-tspm`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.2.5 | | Published | 2018-08-28 | | First published | 2018-02-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=8.3 | | Dependencies | 9 | | Unpacked size | 256.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 66 | | Maintainers | ef-carbon-bot | ## Links - npm: https://www.npmjs.com/package/@ef-carbon/tspm - Repository: https://github.com/ef-carbon/tspm - Homepage: https://github.com/ef-carbon/tspm#readme - Issues: https://github.com/ef-carbon/tspm/issues - npm.io page: https://npm.io/package/@ef-carbon/tspm ## Dependencies (9) - [acorn](https://npm.io/package/acorn.md) ^5.7.2 - [yargs](https://npm.io/package/yargs.md) ^12.0.1 - [core-js](https://npm.io/package/core-js.md) ^2.5.7 - [winston](https://npm.io/package/winston.md) ^3.0.0 - [acorn-jsx](https://npm.io/package/acorn-jsx.md) ^4.1.1 - [escodegen](https://npm.io/package/escodegen.md) ^1.11.0 - [estraverse](https://npm.io/package/estraverse.md) ^4.2.0 - [estraverse-fb](https://npm.io/package/estraverse-fb.md) ^1.3.2 - [escodegen-wallaby](https://npm.io/package/escodegen-wallaby.md) ^1.6.19 ## Recent versions - 2.2.5 (latest) — 2018-08-28 - 2.2.4 — 2018-08-01 - 2.2.3 — 2018-07-16 - 2.2.2 — 2018-06-13 - 2.2.1 — 2018-03-18 - 2.2.0 — 2018-03-18 - 2.1.0 — 2018-02-13 - 2.0.2 — 2018-02-07 - 2.0.1 — 2018-02-07 - 2.0.0 — 2018-02-07 - 1.2.0 — 2018-02-06 - 1.1.0 — 2018-02-06 - 1.0.0 — 2018-02-06 ## README # EF TypeScript Path Mapper [![CircleCI][circleci-badge]][circleci] [![Code Coverage][codecov-badge]][codecov] [![Greenkeeper][greenkeeper-badge]][greenkeeper] [![NPM Version][npm-version-badge]][npm] [![License][license-badge]][license] [![NPM Weekly Downloads][npm-downloads-week-badge]][npm] [![NPM Monthly Downloads][npm-downloads-month-badge]][npm] [![NPM Yearly Downloads][npm-downloads-year-badge]][npm] [![NPM Total Downloads][npm-downloads-total-badge]][npm] [![Node Version][node-version-badge]][node-version] [![Semantic Release][semantic-release-badge]][semantic-release] [![Commitizen friendly][commitizen-badge]][commitizen] [![Conventional Commits][coventional-commits-badge]][coventional-commits] [![GitHub Commits Since Last Release][github-commits-badge]][github] > A binary that converts TypeScript path mappings in the compiled output ## Usage `tsconfig.json` ```json { "compilerOptions": { "outDir": "dist", "baseUrl": ".", "paths": { "@lib/*": ["lib/*"] } } } ``` ``` yarn add -D @ef-carbon/tspm ``` `package.json` ```json { "scripts": { "postbuild": "ef-tspm" } } ``` `@lib` will be updated to the correct relative import in the JavaScript files ### JSX To process projects that use JSX, install the optional ES parsing and generation modules: ``` yarn add -D acorn-jsx escodegen-wallaby estraverse-fb ``` ### Library ```typescript import convert, { IOptions, File } from '@ef-carbon/tspm' const options: IOptions = { tsconfig: './tsconfig.json' }; const files = new Set(); for await (const mapped of convert(options)) { files.add(mapped.file); } for (const file of files) { await file.write(); } ``` Read the [documentation][docs] for library API guidance. ## Development The project attempts to make the workflow as frictionless as possible. Any suggestions to improve the work processes are welcomed :metal: ### Getting Started Get up and running using [yarn][yarn]: ``` yarn install yarn build ``` ### IDE Install [Atom][atom] [IDE][atom-ide] with the [TypeScript][atom-ide-typescript] and [XTerm][atom-xterm] plugins ### Hacking Run `yarn watch:test`. Unit tests will re-run after any changes to the source code. ### Testing The unit tests use [Jest][jest]. ### Releases Releases are performed automatically via [`semantic-release`][semantic-release]. When commits are merged to `master` the [Conventional Commits][coventional-commits] are read and version number determined automatically. ### Scripts There are various scripts available that provide the workflow steps for the project: | Name | Description | | ------------------ | ----------------------------------------------------------------------------------------------- | | `commit` | Starts the [commitizen][commitizen] CLI | | `distclean` | Returns the project to initial state | | `clean` | Returns the project to postinstall state | | `build` | Builds the project | | `build:ts` | Builds the TypeScript files into the JavaScript output | | `format` | Formats the project | | `lint` | Lints the project | | `lint:fix` | Fixes up simple linting rule violations automatically | | `lint:ci` | Validates the CI configuration file | | `lint:ts` | Performs linting of TypeScript files | | `lint:ts:fix` | Fixes up simple rule violations in TypeScript files | | `lint:format` | Checks the formatting of the TypeScript source code | | `lint:format:fix` | Automatically fixes up formatting violations | | `lint:commit` | Makes sure the commits follow the [conventional commits][coventional-commits] style | | `watch:ts` | Watches the TypeScript source files for changes | | `watch:test` | Re-runs unit tests on any file changes | | `test` | Tests the project | | `coverage` | Provides test coverage statistics for the project | | `ci` | Runs a set of commands that are needed to pass the CI workflow | | `fix` | Performs formatting and linting fixes | | `docs` | Builds API documentation | | `docs:open` | Opens up the built API documentation in the default browser | ## Reports ### Coverage [![Code Coverage Graph][codecov-graph]][codecov] [greenkeeper]: https://greenkeeper.io/ [greenkeeper-badge]: https://badges.greenkeeper.io/ef-carbon/tspm.svg [docs]: https://ef-carbon.github.io/tspm/ [yarn]: https://yarnpkg.com [npm]: https://www.npmjs.com/package/@ef-carbon/tspm [codecov]: https://codecov.io/gh/ef-carbon/tspm [codecov-badge]: https://img.shields.io/codecov/c/token/Re0IsMvcF1/github/ef-carbon/tspm.svg [codecov-graph]: https://codecov.io/gh/ef-carbon/tspm/branch/master/graphs/commits.svg?token=Re0IsMvcF1 [npm-version-badge]: https://img.shields.io/npm/v/@ef-carbon/tspm.svg [npm-downloads-week-badge]: https://img.shields.io/npm/dw/@ef-carbon/tspm.svg [npm-downloads-month-badge]: https://img.shields.io/npm/dm/@ef-carbon/tspm.svg [npm-downloads-year-badge]: https://img.shields.io/npm/dy/@ef-carbon/tspm.svg [npm-downloads-total-badge]: https://img.shields.io/npm/dt/@ef-carbon/tspm.svg [license]: https://choosealicense.com/licenses/mit/ [license-badge]: https://img.shields.io/npm/l/@ef-carbon/tspm.svg [node-version]: https://nodejs.org/en/download/releases/ [node-version-badge]: https://img.shields.io/node/v/@ef-carbon/tspm.svg [github]: https://github.com/ef-carbon/tspm [github-commits-badge]: https://img.shields.io/github/commits-since/ef-carbon/tspm/latest.svg [atom]: https://atom.io/ [atom-ide]: https://ide.atom.io/ [jest]: https://facebook.github.io/jest/ [atom-ide-typescript]: https://github.com/atom/ide-typescript [atom-xterm]: https://atom.io/packages/atom-xterm [circleci]: https://circleci.com/gh/ef-carbon/tspm/tree/master [circleci-badge]: https://img.shields.io/circleci/project/github/ef-carbon/tspm.svg [semantic-release]: https://github.com/semantic-release/semantic-release [semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg [commitizen]: http://commitizen.github.io/cz-cli/ [commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg [coventional-commits]: https://conventionalcommits.org [coventional-commits-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg --- _Source: https://npm.io/package/@ef-carbon/tspm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._