-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
gabriel garcia
committed
Mar 31, 2020
1 parent
dd21692
commit 8dd12b3
Showing
7 changed files
with
276 additions
and
132 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,3 +64,4 @@ typings/ | |
# next.js build output | ||
.next | ||
.history | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Change Log | ||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](http://keepachangelog.com/) | ||
and this project adheres to [Semantic Versioning](http://semver.org/). | ||
|
||
## [to-be-deprecated] | ||
|
||
## [unreleased] | ||
### Added | ||
### Changed | ||
### Fixed | ||
### Removed | ||
### BREAKING CHANGES | ||
|
||
|
||
## [1.0.0-beta.2] - 2020-03-31 | ||
### BREAKING CHANGES | ||
- Commands are passed like commands | ||
|
||
## [1.0.0-beta.1] - 2020-03-30 | ||
### Added | ||
- Commands start and stopped are passed like args |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,45 @@ | ||
# typescript-cli-starter | ||
# holded-bot | ||
[![NPM Version](https://img.shields.io/npm/v/holded-bot.svg)](https://www.npmjs.com/package/holded-bot) [![NPM Downloads](https://img.shields.io/npm/dm/holded-bot.svg)](https://www.npmjs.com/package/holded-bot) | ||
|
||
A simple and zero-opinion typescript starter template for building cross-platform command line applications. | ||
> A holded robot responsible to take hours for you | ||
![GitHub package.json dynamic](https://img.shields.io/github/package-json/keywords/khalidx/typescript-cli-starter.svg?style=flat-square) | ||
|
||
![GitHub](https://img.shields.io/github/license/khalidx/typescript-cli-starter.svg?style=flat-square) | ||
![GitHub package.json version](https://img.shields.io/github/package-json/v/khalidx/typescript-cli-starter.svg?style=flat-square) | ||
![GitHub top language](https://img.shields.io/github/languages/top/khalidx/typescript-cli-starter.svg?style=flat-square) | ||
## Installation | ||
|
||
![GitHub last commit](https://img.shields.io/github/last-commit/khalidx/typescript-cli-starter.svg?style=flat-square) | ||
```sh | ||
npm i -g holded-bot | ||
``` | ||
|
||
Includes: | ||
|
||
- [TypeScript](https://www.typescriptlang.org/), for writing good code | ||
- [Ava](https://www.npmjs.com/package/ava), for writing good tests | ||
- [Commander](https://www.npmjs.com/package/commander), for building CLI applications | ||
- [Pkg](https://www.npmjs.com/package/pkg), for building cross-platform native executables | ||
### Requirements | ||
|
||
Your application will be installable from `npm` or by sharing your native executables. | ||
holded-bot requires 3 fields of info to start working for you | ||
|
||
## Usage | ||
* Company: Insert the name of your enterprise holded account, usually it's your company name | ||
* Email: Your email in holded | ||
* Password: Your password in holded | ||
|
||
### **dev** | ||
This fields are saved in your Keychain in mac, in another platforms like linux or windows check the [keytar module](http://atom.github.io/node-keytar/) | ||
|
||
`npm run dev` | ||
|
||
Runs the CLI application. | ||
### Use | ||
|
||
You can pass arguments to your application by running `npm run dev -- --your-argument`. The extra `--` is so that your arguments are passed to your CLI application, and not `npm`. | ||
It has two commands start and stop | ||
|
||
### **clean** | ||
|
||
`npm run clean` | ||
#### Start | ||
|
||
Removes any built code and any built executables. | ||
Start takes the actual time and inserts it in the day of the week. | ||
|
||
### **build** | ||
```sh | ||
holded-bot start | ||
``` | ||
|
||
`npm run build` | ||
#### Stop | ||
|
||
Cleans, then builds the TypeScript code. | ||
Stop commands updates the time when you stop the task | ||
|
||
Your built code will be in the `./dist/` directory. | ||
```sh | ||
holded-bot stop | ||
``` | ||
|
||
### **test** | ||
|
||
`npm run test` | ||
|
||
Cleans, then builds, and tests the built code. | ||
|
||
### **bundle** | ||
|
||
`npm run bundle` | ||
|
||
Cleans, then builds, then bundles into native executables for Windows, Mac, and Linux. | ||
|
||
Your shareable executables will be in the `./exec/` directory. |
Oops, something went wrong.