# tranz > The framework for transform anything Latest version **0.6.0** (published 2018-10-07) · MIT license · 0 weekly downloads ## Install ```sh npm install tranz pnpm add tranz yarn add tranz bun add tranz ``` Provides the command `tranz`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.6.0 | | Published | 2018-10-07 | | First published | 2018-09-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=6 | | Dependencies | 15 | | Unpacked size | 61.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | imcuttle | | Maintainers | moyuyc | | Keywords | imcuttle, tranz | ## Links - npm: https://www.npmjs.com/package/tranz - Repository: https://github.com/imcuttle/tranz - Homepage: https://github.com/imcuttle/tranz#readme - Issues: https://github.com/imcuttle/tranz/issues - npm.io page: https://npm.io/package/tranz ## Dependencies (15) - [pify](https://npm.io/package/pify.md) ^4.0.0 - [execa](https://npm.io/package/execa.md) ^1.0.0 - [verror](https://npm.io/package/verror.md) ^1.10.0 - [minimist](https://npm.io/package/minimist.md) ^1.2.0 - [p-reduce](https://npm.io/package/p-reduce.md) ^1.0.0 - [quote-it](https://npm.io/package/quote-it.md) ^1.0.1 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^5.0.6 - [json-buffer](https://npm.io/package/json-buffer.md) ^3.0.1 - [is-plain-obj](https://npm.io/package/is-plain-obj.md) ^1.1.0 - [loader-utils](https://npm.io/package/loader-utils.md) ^1.1.0 - [resolve-from](https://npm.io/package/resolve-from.md) ^4.0.0 - [concat-stream](https://npm.io/package/concat-stream.md) ^1.6.2 - [lodash.isempty](https://npm.io/package/lodash.isempty.md) ^4.4.0 - [module-interop](https://npm.io/package/module-interop.md) ^1.2.0 - [@moyuyc/worker-farm](https://npm.io/package/@moyuyc/worker-farm.md) ^1.6.0 ## Recent versions - 0.6.0 (latest) — 2018-10-07 - 0.5.0 — 2018-10-06 - 0.4.3 — 2018-10-03 - 0.4.2 — 2018-09-29 - 0.4.1 — 2018-09-29 - 0.3.0 — 2018-09-29 - 0.2.2 — 2018-09-29 - 0.2.1 — 2018-09-29 - 0.2.0 — 2018-09-29 - 0.1.0 — 2018-09-28 ## README # tranz [![Build status](https://img.shields.io/travis/imcuttle/tranz/master.svg?style=flat-square)](https://travis-ci.org/imcuttle/tranz) [![Test coverage](https://img.shields.io/codecov/c/github/imcuttle/tranz.svg?style=flat-square)](https://codecov.io/github/imcuttle/tranz?branch=master) [![NPM version](https://img.shields.io/npm/v/tranz.svg?style=flat-square)](https://www.npmjs.com/package/tranz) [![NPM Downloads](https://img.shields.io/npm/dm/tranz.svg?style=flat-square&maxAge=43200)](https://www.npmjs.com/package/tranz) [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org) The framework for transform anything ## Feature - Allow running shell script as processor - Allow concurrent multi-processor for fast speed - Support runtime configuration ## Where use it? - Transform git commit message for your self own processor. Use it with [husky (Git hooks made easy)](https://github.com/typicode/husky) ```json { "tranz": { "processors": ["echo '$(cat)\n\nbranch: $(git rev-parse --abbrev-ref HEAD)'"] }, "husky": { "hooks": { "commit-msg": "npx tranz $HUSKY_GIT_PARAMS --write" } } } ``` Then the end of commit message would be appended with current branch name. ## Installation ```bash npm install tranz # or use yarn yarn add tranz ``` ## Usage ### Package #### `tranz(input: any, processors: Array, options?): Promise` - `index.js` ```javascript import { join } from 'path' import tranz from 'tranz' tranz( 'abc', [ // function require('./lib/wrapper')({ c: '-' }), // return Processor[] require('./lib/multi-wrapper')({ c: 0 }), // [moduleId: string, options: any] ['./wrapper', { c: '_' }], // module name with query string './wrapper?c=$', // shell script // get input from stdin // output from stdout 'echo $(cat)-abc' ], { // Resolve processor path's base dir // Default: $PWD cwd: join(__dirname, 'lib'), // Whether run tranz parallelly // Note: parallel mode could enabled when all of the processor is typeof `string` (serializable) // Default: false parallel: false, // Search runtime configuration. // e.g. 1. `tranz` field in `package.json` // 2. file named `.tranzrc` // 3. file named `.tranzrc.js` // Default: true userc: true } ).then(output => { console.log(output) }) // Output: // $_10-abc-01_$-abc ``` - `lib/wrapper.js` ```javascript module.exports = ({ c }) => function(input) { // this.cwd === __dirname // this.parallel === false // this.userc === true // `this` is equals to options shallowly return `${c}${input}${c}` } ``` - `lib/multi-wrapper.js` ```javascript module.exports = ({ c }) => [input => `${c}${input}${c}`, input => Promise.resolve(`${c + 1}${input}${c + 1}`)] ``` ### CLI ``` npm i tranz -D npx tranz -h tranz -i $PWD -p ./upper cat $PWD | tranz -p ./upper ``` ### RC Config - `package.json` ```json { "tranz": { "processors": [ [ "../processor-wrapper", { "char": "abc" } ], "../processor-upper", "module-p-fix?q=halala" ], "parallel": false } } ``` ### Bulit-in Processor See [source code](src/presets) - \_json-parse - run `JSON.parse(input, reviver?)` - \_json-stringify - run `JSON.stringify(input, replacer?, space?)` #### Example ```javascript tranz({ key: 'foo' }, [['_json-stringify', { space: 2 }]]).then(output => { // { // "key": "foo" // } }) ``` ### Processor Inheritance Write the processor as follow: ```javascript // This processor depends `./upper` and `./trimLeft` processor module.exports = opts => [require('./upper')({}), [require.resolve('./trimLeft'), {}]] ``` ### Multi-tranz config in rc config - `package.json` ```json { "tranz": { "foo": { "processors": [ "echo foo" ], "parallel": true } "processors": [ "echo default" ], "parallel": false } } ``` - Run command in shell ```bash tranz --input="" # echo default tranz --input="" --name="foo" # echo foo ``` ## Tests ### Unit ```bash npm test ``` ### Benchmark ```bash npm run benchmark ``` ## Roadmap - [ ] file write [tranz-globs] - [ ] file glob [tranz-globs] - [ ] ignore files [tranz-globs] ## Related ## Authors This library is written and maintained by imcuttle, moyuyc95@gmail.com. ## License MIT --- _Source: https://npm.io/package/tranz · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._