Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tanem/tanem-scripts
:nut_and_bolt: Common scripts for my projects.
https://github.com/tanem/tanem-scripts
authors changelog changelog-generator cli generator git github javascript markdown node script scripts shortlog typescript
Last synced: 8 days ago
JSON representation
:nut_and_bolt: Common scripts for my projects.
- Host: GitHub
- URL: https://github.com/tanem/tanem-scripts
- Owner: tanem
- License: mit
- Created: 2019-07-17T07:25:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T17:41:47.000Z (7 months ago)
- Last Synced: 2024-04-13T18:09:34.179Z (7 months ago)
- Topics: authors, changelog, changelog-generator, cli, generator, git, github, javascript, markdown, node, script, scripts, shortlog, typescript
- Language: TypeScript
- Homepage: https://npm.im/tanem-scripts
- Size: 27.6 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# tanem-scripts
[](https://www.npmjs.com/package/tanem-scripts)
[](https://github.com/tanem/tanem-scripts/actions?query=workflow%3ACI)
[](https://codecov.io/gh/tanem/tanem-scripts)
[](https://www.npmjs.com/package/tanem-scripts)
> Common scripts for my projects.
## Usage
```
Usage: tanem-scripts [options] [command]
Common scripts for my projects.
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
authors generates a list of authors in a format suitable for inclusion in an AUTHORS file
changelog [options] generates a changelog using GitHub tags and pull requests
release runs npm-version with a valid semver.inc argument
```
## API
### authors()
Returns a `Promise` that will be resolved with a list of authors sorted alphabetically by author name. If an error occurs during execution, the `Promise` is rejected with an `Error` object.
**Example**
```ts
// Note: The `fs.promises` API was added in Node.js v10.0.0.
import { promises as fs } from 'fs';
import path from 'path';
import { authors } from 'tanem-scripts';
(async () => {
try {
const result = await authors();
await fs.writeFile(path.join(__dirname, 'AUTHORS'), result, 'utf-8');
} catch (error) {
console.error(error);
}
})();
```
---
### changelog([options])
Returns a `Promise` that will be resolved with the changelog. If an error occurs during execution, the `Promise` is rejected with an `Error` object.
**Arguments**
- `options` - _Optional_ An object containing the optional arguments defined below. Defaults to `{}`.
- `futureRelease` - _Optional_ Tag to use for PRs merged since the last published tag. If unspecified, those PRs will be excluded.
**Example**
```ts
// Note: The `fs.promises` API was added in Node.js v10.0.0.
import { promises as fs } from 'fs';
import path from 'path';
import { changelog } from 'tanem-scripts';
(async () => {
try {
const result = await changelog({
futureRelease: 'v2.0.0',
});
await fs.writeFile(path.join(__dirname, 'CHANGELOG.md'), result, 'utf-8');
} catch (error) {
console.error(error);
}
})();
```
---
### release()
Returns a `Promise` that will be resolved once the release script completes. If an error occurs during execution, the `Promise` is rejected with an `Error` object.
**Example**
```ts
import { release } from 'tanem-scripts';
(async () => {
try {
await release();
} catch (error) {
console.error(error);
}
})();
```
## Installation
```
$ npm install tanem-scripts --save-dev
```
You'll also need to generate a new [GitHub personal access token](https://github.com/settings/tokens), then set an environment variable by running the following command at the prompt or by adding it to your shell profile:
```sh
export CHANGELOG_GITHUB_TOKEN=
```
## License
MIT