ChangeLog Parser

- Description

Return the details of the new fixes, features, updates or improvements for a specific tag or the whole history of your repository, tag by tag. The message that will be returned by the tool are the message you'll write in your PR, not your commits.

- Convention

It begins with your type of commit into brackets. Then follows the description of your PR. If nothing follows the type of your PR, it won't be listed in the changelog.

Here is an example

"[Feat/Fix/Improvement/Update] This is awesome

- Commands

Use this instruction to execute the script:

sf-tools changelog

• --path: specify the location of the repository of which you want the changeLog. By default use your current location.
• --tag: if you specify "all", you will get the changeLog for all the tag of the repository. Otherwise return the changeLog only for the tag you specify. If you specify a non existing tag, it will return the last changes of the branch and act as these changes where for the non existing tag. By default return the changeLog of the last tag.
• --output: provide the name of a file you want the changeLog to be written into. By default, issues are logged.

GitHub Issues

- Description

When running npm install sf-tooling, the issues tool will be installed. This installation contains 3 git hooks: post-merge and pre-rebase which retrieve the issues of your repository and write it into a file, prepare-commit-message which write the issues previously retrieved. It uses the url or urls keys in package.json to know where to find the issues to retrieve. You can also execute this tool with command lines in your terminal.

- Commands

Use this instruction to execute the script:

sf-tools issues

• --package: provide the location of the package you want to use. Package of your current repository used by default.
• --url: provide the issues url of the repository you want to get the issues. Repository of your current location used by default. If both url and package are used, only package will be considered.
• --output: provide the name of a file you want the issues to be written into. By default, issues are logged.
• --notoken: if specified, the tool won't ask you for your gitHub token. Ask you by default.

Generator

- Description

This tool allows you to generate automatically in few secondes a folder containing the basics folders and files you need to start your project. It allows you to quickly start an API, a CLI, a Lib and a front project.

- Commands

You can use the yo tool, followed by the type of project you want to start.

For exemple, if you want to start a Lib: sf-tools lib

Then, just let it carry you!