Skip to content

Commit 340484d

Browse files
agubleragubler
committed
Initial repo skeleton
1 parent 728db2a commit 340484d

17 files changed

+458
-1
lines changed

‎.appveyor.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Test against the latest version of this Node.js version
2+
environment:
3+
nodejs_version: "6"
4+
FORCE_COLOR: 1
5+
6+
# Install scripts. (runs after repo cloning)
7+
install:
8+
# Get the latest stable version of Node.js or io.js
9+
- ps: Install-Product node $env:nodejs_version
10+
# install modules
11+
- npm install
12+
13+
# Post-install test scripts.
14+
test_script:
15+
# Output useful info for debugging.
16+
- node --version
17+
- npm --version
18+
# run tests
19+
- npm test
20+
- npm run uploadCoverage
21+
22+
# Don't actually build.
23+
build: off

‎.github/CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Thank You
2+
3+
We very much welcome contributions to Dojo.
4+
5+
Because we have so many repositories that are part of Dojo, we have located our [Contributing Guidelines](https://github.com/dojo/meta/blob/master/CONTRIBUTING.md) in our [Dojo Meta Repository](https://github.com/dojo/meta#readme).
6+
7+
Look forward to working with you on Dojo!!!

‎.github/ISSUE_TEMPLATE.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!--
2+
Thank you for contributing to Dojo.
3+
4+
Our issue tracker is for bugs for Dojo.
5+
6+
Please make sure you have read our Contributing Guidelines
7+
available at: https://github.com/dojo/meta/blob/master/CONTRIBUTING.md
8+
9+
For general questions and discussion, join us on Discord at: https://discord.gg/M7yRngE
10+
-->
11+
12+
**Bug / Enhancement** <!-- delete as appropriate -->
13+
14+
<!-- Summary of enhancement or bug-->
15+
16+
Package Version: <!-- package version -->
17+
18+
**Code**
19+
20+
<!-- a self contained example of code that demonstrates the issue -->
21+
22+
**Expected behavior:**
23+
24+
<!-- What did you expect to happen -->
25+
26+
**Actual behavior:**
27+
28+
<!-- What was the actual behavior? -->

‎.github/PULL_REQUEST_TEMPLATE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
**Type:** bug / feature
2+
3+
The following has been addressed in the PR:
4+
5+
* [ ] There is a related issue
6+
* [ ] All code has been formatted with [`prettier`](https://prettier.io/) as per the [readme code style guidelines](./../#code-style)
7+
* [ ] Unit or Functional tests are included in the PR
8+
9+
<!--
10+
Our bots should ensure:
11+
12+
* [ ] All contributors have signed a CLA
13+
* [ ] The PR passes CI testing
14+
* [ ] Code coverage is maintained
15+
* [ ] The PR has been reviewed and approved
16+
-->
17+
18+
**Description:**
19+
20+
Resolves #???

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
coverage
3+
dist

‎.travis.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
sudo: false
2+
language: node_js
3+
node_js:
4+
- '6'
5+
env:
6+
global:
7+
- SAUCE_USERNAME: dojo2-ts-ci
8+
- SAUCE_ACCESS_KEY: e92610e3-834e-4bec-a3b5-6f7b9d874601
9+
- FORCE_COLOR: 1
10+
install:
11+
- travis_retry npm install
12+
script:
13+
- npm test
14+
- npm run uploadCoverage
15+
notifications:
16+
slack:
17+
secure: O9m3cCkl3H8VXRIuKLFfx91C01n9yLlehem9K3snnBMiyrtGWR2aXo+t1eeZYGfFWIl8UBEaSPlDurI1KspIcW/JbszuYAVje21rbl+ptkp008f5gDVfFCFpqdM9S5+lrVJLlx1mrikWKBRsjYqZHYV9EJx/ss+P86JsQ0utC7zgBFYId+UCMybAemzi1FPfeULFWpoi8QavoN8fNr4yHBayrqOlqnnIhlYLoTiGL6yY8L/meUrmWVxSY3JMDxLeIYNppt4puvTGUD1hU2LZgFZp1y6jGMcAlZI5amGV+iyTl/h2w1wiB6q5tolJ1JslosFvh53y7+1Crbm8wQDkX42+z7Rn3/jXRUBFwLZBGZQ99FcE0Yz+XBaQA3GuCgPNd0rcHmJxeYAKMm7jg2B8Nzd6It3q5mjdp9ITA5kR2G7g+iH8R4y112FXCpvt4/RUvHuyhl7w8lFlHK+LslH3DBjDi3fKUuwiGtU8oD3xpCunJ4JUgQmAWIOy3mpFIOX4QPcBKqByp10fNw3G73JDsJ9DXrFGb/+WnA2OgpDnKOnjoporwufRZLeioRwCJAWM0DbFDvRc1mbnECwcKiedzKdTxSWUGyJ6sxKydZtC11tF356BkzIsf3x7cKSed2LI8VXYNiPOJu9P+/s5/jRf/7kZ+i2ETfuKZC2awhgkBGo=
18+
on_success: change

‎LICENSE

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
The "New" BSD License
2+
*********************
3+
4+
Copyright (c) 2016-2019, [JS Foundation](https://js.foundation/).
5+
All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without
8+
modification, are permitted provided that the following conditions are met:
9+
10+
* Redistributions of source code must retain the above copyright notice, this
11+
list of conditions and the following disclaimer.
12+
* Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
* Neither the name of the JS Foundation nor the names of its contributors
16+
may be used to endorse or promote products derived from this software
17+
without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

+58-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
11
# cli-test-unit
2-
Dojo command for unit tests
2+
3+
[![Build Status](https://travis-ci.org/dojo/cli-test-unit.svg?branch=master)](https://travis-ci.org/dojo/cli-test-unit)
4+
[![Build status](https://ci.appveyor.com/api/projects/status/nbgg2yf7hepsvvn2/branch/master?svg=true)](https://ci.appveyor.com/project/Dojo/cli-test-unit/branch/master)
5+
[![codecov](https://codecov.io/gh/dojo/cli-test-unit/branch/master/graph/badge.svg)](https://codecov.io/gh/dojo/cli-test-unit)
6+
[![npm version](https://badge.fury.io/js/%40dojo%2Fcli-test-unit.svg)](https://badge.fury.io/js/%40dojo%2Fcli-test-unit)
7+
8+
The official Dojo unit test command. This package uses Intern to run unit tests against your Dojo project.
9+
10+
## Usage
11+
12+
### Prerequisites
13+
14+
This project is a command for the [Dojo CLI]. Please visit the Dojo CLI project for information about the project and how to install.
15+
16+
### Installation
17+
18+
The use `@dojo/cli-test-unit` in a project, install the package:
19+
20+
```bash
21+
npm install @dojo/cli-test-unit
22+
```
23+
24+
### Basic Usage
25+
26+
```bash
27+
dojo test unit
28+
```
29+
30+
## How do I contribute?
31+
32+
We appreciate your interest! Please see the [Dojo Meta Repository](https://github.com/dojo/meta#readme) for the Contributing Guidelines.
33+
34+
### Code Style
35+
36+
This repository uses [`prettier`](https://prettier.io/) for code styling rules and formatting. A pre-commit hook is installed automatically and configured to run `prettier` against all staged files as per the configuration in the projects `package.json`.
37+
38+
An additional npm script to run `prettier` (with write set to `true`) against all `src` and `test` project files is available by running:
39+
40+
```bash
41+
npm run prettier
42+
```
43+
44+
## Testing
45+
46+
Test cases MUST be written using [Intern] using the "bdd" test interface and "assert" assertion interface.
47+
48+
90% branch coverage MUST be provided for all code submitted to this repository, as reported by Istanbul’s combined coverage results for all supported platforms.
49+
50+
To test locally in node run:
51+
52+
`npm test`
53+
54+
© 2018 [JS Foundation] & contributors. [New BSD](LICENSE) license.
55+
56+
[Dojo CLI]: https://github.com/dojo/cli
57+
[Intern]: https://theintern.io/
58+
[JS Foundation]: https://js.foundation/
59+
>>>>>>> Initial repo skeleton

‎codecov.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
comment:
2+
branches:
3+
- master
4+
- feature/*

‎intern.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"extends": "./node_modules/@dojo/scripts/intern/base.json",
3+
"capabilities+": {
4+
"name": "@dojo/cli-test-unit"
5+
}
6+
}

‎package.json

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{
2+
"name": "@dojo/cli-test-unit",
3+
"version": "4.0.0-pre",
4+
"description": "",
5+
"private": true,
6+
"homepage": "https://dojo.io",
7+
"license": "BSD-3-Clause",
8+
"main": "main.js",
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/dojo/cli-test-unit.git"
12+
},
13+
"scripts": {
14+
"build:static:dev": "cpx \"{src,tests}/**/*.{d.ts,json,test}\" dist/dev",
15+
"build:static:release": "cpx \"src/**/*.{d.ts,json}\" dist/release",
16+
"build:cjs": "tsc",
17+
"build": "npm-run-all -p build:** -s dojo-package",
18+
"clean": "rimraf dist coverage",
19+
"dojo-package": "dojo-package",
20+
"dojo-release": "dojo-release",
21+
"intern": "intern",
22+
"lint:tslint": "tslint -p .",
23+
"lint:prettier": "prettier -l \"{src,tests}/**/*.{ts,tsx}\"",
24+
"lint": "run-p lint:*",
25+
"precommit": "lint-staged",
26+
"prettier": "prettier --write \"{src,tests}/**/*.{ts,tsx}\"",
27+
"release": "run-s lint clean build \"dojo-release -- {@}\" --",
28+
"test": "run-s lint build intern",
29+
"uploadCoverage": "codecov --file=coverage/coverage.json",
30+
"watch:ts": "dojo-tsc-watcher -p tsconfig.json -- dojo-package",
31+
"watch": "run-p watch:ts \"build:static:** -- --watch\""
32+
},
33+
"devDependencies": {
34+
"@dojo/cli": "^4.0.0",
35+
"@dojo/scripts": "^3.1.0",
36+
"@types/chalk": "2.2.0",
37+
"@types/chokidar": "1.7.5",
38+
"@types/cross-spawn": "6.0.0",
39+
"@types/css-modules-require-hook": "4.0.1",
40+
"@types/figures": "2.0.0",
41+
"@types/fs-extra": "5.0.4",
42+
"@types/jsdom": "11.0.4",
43+
"@types/log-update": "2.0.0",
44+
"@types/mockery": "^1.4.29",
45+
"@types/ora": "3.0.0",
46+
"@types/sinon": "~4.3.3",
47+
"@types/yargs": "^8.0.2",
48+
"cpx": "^1.5.0",
49+
"mockery": "^1.7.0",
50+
"npm-run-all": "^4.1.5",
51+
"prettier": "^1.15.3",
52+
"rimraf": "^2.6.2",
53+
"sinon": "~4.5.0",
54+
"typescript": "~2.6.1",
55+
"yargs": "^5.0.0"
56+
},
57+
"dependencies": {
58+
},
59+
"lint-staged": {
60+
"*.{ts,tsx}": [
61+
"prettier --write",
62+
"git add"
63+
]
64+
},
65+
"prettier": {
66+
"singleQuote": true,
67+
"tabWidth": 4,
68+
"useTabs": true,
69+
"parser": "typescript",
70+
"printWidth": 120,
71+
"arrowParens": "always"
72+
}
73+
}

‎src/main.ts

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
import { Command, Helper, OptionsHelper } from '@dojo/cli/interfaces';
2+
import * as path from 'path';
3+
import * as chokidar from 'chokidar';
4+
import { emptyDirSync } from 'fs-extra';
5+
import chalk from 'chalk';
6+
7+
const foreground = require('foreground-child');
8+
const NYC = require('nyc/index');
9+
const sw = require('spawn-wrap');
10+
const wrapper = require.resolve('nyc/bin/wrap.js');
11+
const config = require('./nyc.json');
12+
13+
export interface CommandArgs {
14+
watch: true;
15+
}
16+
17+
let isRunning = false;
18+
let shouldRun = false;
19+
const internPath = path.resolve('node_modules/.bin/intern');
20+
const configPath = path.relative(process.cwd(), path.join(__dirname, 'intern.json'));
21+
22+
function runner() {
23+
isRunning = true;
24+
console.log(chalk.greenBright('Running unit tests...\n'));
25+
emptyDirSync(path.join(process.cwd(), 'output', 'coverage', '.cache'));
26+
const nyc = new NYC();
27+
nyc.createTempDirectory();
28+
nyc.addAllFiles();
29+
30+
const env = {
31+
NYC_CONFIG: JSON.stringify(config),
32+
NYC_CWD: process.cwd(),
33+
NYC_ROOT_ID: nyc.rootId,
34+
NYC_INSTRUMENTER: config.instrumenter
35+
};
36+
37+
sw([wrapper], env);
38+
39+
process.exitCode = 0;
40+
foreground([internPath, `config=${configPath}`], () => {
41+
report(config);
42+
isRunning = false;
43+
if (shouldRun) {
44+
shouldRun = false;
45+
runner();
46+
}
47+
});
48+
function report(config: any) {
49+
process.env.NYC_CWD = process.cwd();
50+
const nyc = new NYC(config);
51+
nyc.report();
52+
}
53+
}
54+
55+
const command: Command<CommandArgs> = {
56+
description: 'Run unit tests',
57+
register(options: OptionsHelper) {
58+
options('w', {
59+
alias: 'watch',
60+
describe: 'Re-runs unit tests when a file is changed',
61+
default: false
62+
});
63+
},
64+
run(helper: Helper, args: CommandArgs) {
65+
return new Promise(() => {
66+
if (args.watch) {
67+
const watcher = chokidar
68+
.watch([path.join(process.cwd(), 'src'), path.join(process.cwd(), 'tests')], {
69+
ignored: /node_modules/,
70+
ignoreInitial: true
71+
})
72+
.on('all', () => {
73+
if (!isRunning) {
74+
runner();
75+
} else {
76+
shouldRun = true;
77+
}
78+
});
79+
process.on('SIGINT', () => watcher.close());
80+
}
81+
runner();
82+
});
83+
}
84+
};
85+
export default command;

0 commit comments

Comments
 (0)