Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tessel/t2-cli
Tessel 2 Command Line Interface
https://github.com/tessel/t2-cli
Last synced: about 2 months ago
JSON representation
Tessel 2 Command Line Interface
- Host: GitHub
- URL: https://github.com/tessel/t2-cli
- Owner: tessel
- License: mit
- Created: 2015-02-06T01:27:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-01-23T19:02:24.000Z (almost 5 years ago)
- Last Synced: 2024-07-07T10:07:23.629Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.41 MB
- Stars: 114
- Watchers: 30
- Forks: 56
- Open Issues: 195
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-for-beginners - Tessel 2 CLI - starter)_ <br> Command line interface to Tessel 2. (JavaScript)
- fucking-awesome-for-beginners - Tessel 2 CLI - starter)_ <br> Command line interface to Tessel 2. (JavaScript)
README
# t2-cli
[](https://greenkeeper.io/)
[](https://github.com/tessel/project/blob/master/CONDUCT.md)
[](https://tessel-slack.herokuapp.com/)
[](https://travis-ci.org/tessel/t2-cli)
[](https://ci.appveyor.com/project/rwaldron/t2-cli)
[](https://coveralls.io/github/tessel/t2-cli?branch=master)
[](https://www.codetriage.com/tessel/t2-cli)
The starting point for the Tessel 2 command line interface.
Documentation: [Tessel 2 Command Line Interface](https://tessel.gitbooks.io/t2-docs/content/API/CLI.html)
## Contents
* [Installation for development](#installation-for-development)
* [Updating Tessel](#updating)
* [Testing](#testing)
* [Releasing](#releasing)
## Installation for development
Prerequisites for installation: [Node.js](https://nodejs.org/) and [Git](https://git-scm.com/downloads).
1. Clone this repository by entering the following: `git clone https://github.com/tessel/t2-cli`.
2. Go to the root directory of repository: `cd t2-cli`.
3. Create a symbolic link: `npm link --local`.
#### Windows
You may encounter the following error when executing `npm link` on windows:
```
19798 error Windows_NT 6.3.9600
19799 error argv "C:\\Program Files\\nodejs\\\\node.exe" "C:\\Program Files\\nodejs\\node_modules\\npm\\bin\\npm-cli.js" "link"
19800 error node v0.12.4
19801 error npm v2.10.1
19802 error code ELIFECYCLE
19803 error [email protected] postinstall: `tessel install-drivers || true; tessel trademark || true`
19803 error Exit status 1
19804 error Failed at the [email protected] postinstall script 'tessel install-drivers || true; tessel trademark || true'.
```
This error occurs because of windows folder permissions. To resolve this make sure you are running cmd or powershell as an administrator and that the permissions on the node_modules folder is set to full control for the user.
#### Source Tab Completion
For bash users, add this line to your `~/.bashrc` or `~/.bash_profile` file:
`source /PATH/TO/t2-cli/bash_completion`
For zsh users, add these lines to your `~/.zshrc` file:
```
# Add custom completion scripts
fpath=(/PATH/TO/t2-cli $fpath)
# compsys initialization
autoload -U compinit
compinit
```
## Updating
Just run `t2 update` to make sure you are running the most recent build of OpenWRT and firmware.
## Testing
### Overview
In order to maintain a reliable code base, there is extensive code coverage and style checking involved with adding to or editing this repo. [Grunt](http://gruntjs.com) is used as the task runner, along with plugins for the following tools:
- [jshint](http://jshint.com/docs/): used to verify our best practices and prevents us from making mistakes that could lead to hard-to-find bugs, see [`.jshintrc`](https://github.com/tessel/t2-cli/blob/master/.jshintrc) for our configuration
- [jscs](http://jscs.info): used to maintain the project's preferred code style, see [`.jscsrc`](https://github.com/tessel/t2-cli/blob/master/.jscsrc) for our configuration
- [jsbeautifier](https://github.com/beautify-web/js-beautify): used to format code into the repo's preferred style, see [`Gruntfile.js`](https://github.com/tessel/t2-cli/blob/master/Gruntfile.js#L62) for our configuration
- [nodeunit](https://github.com/caolan/nodeunit): used to create and run unit tests
All of these tasks can be run by entering `npm test` (an alias for `grunt test` without needing to have the `grunt-cli` installed globally) into your command line. Be sure to run this command before pushing new code so JSHint and style errors can be caught as soon as possible.
### Writing Tests
Check out the [nodeunit documentation](https://github.com/caolan/nodeunit#usage) for general usage of the library. For this project, there is a global test setup file (found under [`test/common/bootstrap.js`](https://github.com/tessel/t2-cli/blob/master/test/common/bootstrap.js)) for including any dependencies needed to run the various test modules, as well as two simulator modules, [`RemoteProcessSimulator`](https://github.com/tessel/t2-cli/blob/master/test/common/remote-process-simulator.js) and [`TesselSimulator`](https://github.com/tessel/t2-cli/blob/master/test/common/tessel-simulator.js), for simulating command line and hardware interactions in the tests.
Unit tests are found in the [`test/unit/`](https://github.com/tessel/t2-cli/tree/master/test/unit) directory, named after the feature being tested. A typical unit test looks like the following example:
```js
// Test dependencies are required and exposed in common/bootstrap.js
// The module name is usually the name of the function being tested, i.e. Tessel.prototype.findAvailableNetworks
exports['functionName'] = {
// this is called before the each test is run
setUp(done) {
// sinon is used to watch and mock parts of the Tessel codebase used by the tested function
this.sandbox = sinon.sandbox.create();
this.functionName = this.sandbox.spy(Tessel.prototype, 'functionName');
// create a new TesselSimulator to be used by this module
this.tessel = TesselSimulator();
done();
},
// this is called after each test is run, should cleanup all mocks
tearDown(done) {
this.tessel.mockClose();
this.sandbox.restore();
done();
},
// this should be something recognizable and clearly states what outcome of the function is being tested
testName(test) {
// the number of assertions the test should expect
test.expect(1);
this.tessel.functionName();
// `equal` is a function passed through by the Node.js `assert` module, see https://github.com/caolan/nodeunit#api-documentation for more info
// `callCount` is a property from Sinon's spy, see http://sinonjs.org/docs/#spies for more info
test.equal(this.functionName.callCount, 1);
// this should always be called when every assertion is done
test.done();
}
};
```
## Releasing
For all releases, a maintainer will complete the following steps:
1. Update the version, commit it, and tag it (all of these things happen with the following command):
```
npm version [ | major | minor | patch]
```
Where `` is either "major", "minor" or "patch" (currently, we are in pre-1.0 "patch" releases). More than likely, you will type `npm version patch`.
2. `git push --tags` (or `git push remote-name --tags`, where `remote-name` is the name of your remote that points to `[email protected]:tessel/t2-cli.git`)
3. `git push remote-name master`
4. `grunt changelog` will produce a pre-formatted changelog that looks something like this:
```
| Commit | Message/Description |
| ------ | ------------------- |
| sha | we fixed stuff |
```
Copy the table to clipboard
5. Open https://github.com/tessel/t2-cli/releases and click `Edit` on the right hand side of the "Latest Release":
Type the tag name into the "Release title" field:
Paste the changelog into the "Describe this release" field:
When complete it will look something like this:
6. Publish updated module to npm:
If not logged in to npm through the cli, do so: `npm login`
Then: `npm publish`
Check the [npm page](https://www.npmjs.com/package/t2-cli) to see the latest release!