https://github.com/imcuttle/tranz
The framework for transform anything
https://github.com/imcuttle/tranz
child-process commit-message transfom
Last synced: about 1 year ago
JSON representation
The framework for transform anything
- Host: GitHub
- URL: https://github.com/imcuttle/tranz
- Owner: imcuttle
- License: mit
- Created: 2018-09-28T16:32:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T14:23:35.000Z (over 4 years ago)
- Last Synced: 2025-03-18T15:05:30.310Z (over 1 year ago)
- Topics: child-process, commit-message, transfom
- Language: TypeScript
- Homepage:
- Size: 120 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License
Awesome Lists containing this project
README
# tranz
[](https://travis-ci.org/imcuttle/tranz)
[](https://codecov.io/github/imcuttle/tranz?branch=master)
[](https://www.npmjs.com/package/tranz)
[](https://www.npmjs.com/package/tranz)
[](https://prettier.io/)
[](https://conventionalcommits.org)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fimcuttle%2Ftranz?ref=badge_shield)
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
// It's useful about below multi-config
// name: 'foo'
}
).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
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fimcuttle%2Ftranz?ref=badge_large)