Skip to content

Commit

Permalink
Change project to use validation project pattern
Browse files Browse the repository at this point in the history
  • Loading branch information
DrSammyD committed Jul 6, 2019
1 parent 587de79 commit e5e277d
Show file tree
Hide file tree
Showing 71 changed files with 7,107 additions and 14,206 deletions.
45 changes: 45 additions & 0 deletions .circleci/config.yml
@@ -0,0 +1,45 @@
version: 2.1

map-1: &filter_only_develop
filters:
branches:
only: develop

map-2: &filter_only_tag
filters:
branches:
ignore: /.*/
tags:
only: /^v?[0-9]+(\.[0-9]+)*$/

orbs:
v1: aurelia/v1@volatile

workflows:
main:
jobs:
- v1/build_test
- v1/build_merge:
<<: *filter_only_develop
requires:
- v1/build_test
- v1/npm_publish:
<<: *filter_only_tag
name: npm_publish_dry
args: "--dry-run"
- request_publish_latest:
<<: *filter_only_tag
type: approval
requires:
- npm_publish_dry
- v1/npm_publish:
<<: *filter_only_tag
name: npm_publish
context: Aurelia
requires:
- request_publish_latest
- v1/merge_back:
<<: *filter_only_tag
requires:
- npm_publish

9 changes: 7 additions & 2 deletions .editorconfig
Expand Up @@ -5,10 +5,15 @@ root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
end_of_line = crlf
insert_final_newline = true

# 2 space indentation
[**.*]
indent_style = space
indent_size = 2
indent_size = 2

[node_modules/**/*,dist/**/*]
insert_final_newline = false
indent_style = none
indent_size = none
8 changes: 0 additions & 8 deletions .eslintrc.json

This file was deleted.

8 changes: 7 additions & 1 deletion .gitignore
Expand Up @@ -3,4 +3,10 @@ jspm_packages
bower_components
.idea
.DS_STORE
build/reports
*.swp
npm-debug.log*
.test
.rollupcache
dist/doc-temp
dist/test
dist
19 changes: 15 additions & 4 deletions .npmignore
@@ -1,4 +1,15 @@
jspm_packages
bower_components
.idea
build/reports
.vscode
doc
src
test
.editorconfig
.gitignore
.npmignore
circle.yml
CONTRIBUTING.md
ISSUE_TEMPLATE.md
karma.conf.js
rollup.config.js
tsconfig.build.json
tsconfig.json
tslint.json
5 changes: 5 additions & 0 deletions .vscode/extensions.json
@@ -0,0 +1,5 @@
{
"recommendations": [
"eg2.tslint"
]
}
7 changes: 7 additions & 0 deletions .vscode/settings.json
@@ -0,0 +1,7 @@
{
"typescript.tsdk": "node_modules/typescript/lib",
"tslint.nodePath": "./node_modules/tslint/bin/tslint",
"editor.formatOnSave": false,
"json.format.enable": false,
"typescript.format.enable": true
}
64 changes: 27 additions & 37 deletions README.md
Expand Up @@ -17,52 +17,42 @@ You can read documentation on dependency injection [here](https://aurelia.io/doc

This library can be used in the **browser** as well as on the **server**.

## Building The Code
## Reporting Issues

To build the code, follow these steps.
Please refer to the [issue template](ISSUE_TEMPLATE.md). Accompany any bug report with a demo of the issue using a [runnable Gist](https://gist.run/?id=381fdb1a4b0865a4c25026187db865ce).

1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:
## Building

```shell
npm install
```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:
```shell
npm run build
```

```shell
npm install -g gulp
```
4. To build the code, you can now run:
## Tests

```shell
gulp build
```
5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.
```shell
npm run test
```

6. See `gulpfile.js` for other tasks related to generating the docs and linting.
## Developing

## Running The Tests
Run the tests in watch mode:

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
```shell
npm run develop
```

1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:
## Publishing

```shell
npm install -g karma-cli
```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:
1. Bump the version

```shell
npm run bump-version [<newversion> | major | minor | patch]
```

```shell
npm install -g jspm
```
3. Install the client-side dependencies with jspm:
2. Prepare the release (run tests, run build, docs, release notes)

```shell
npm run prepare-release
```

```shell
jspm install
```

4. You can now run the tests with this command:

```shell
karma start
```
3. Commit, tag, npm publish (not automated)
2 changes: 1 addition & 1 deletion bower.json
@@ -1,6 +1,6 @@
{
"name": "aurelia-dependency-injection",
"version": "1.4.2",
"version": "1.4.4",
"description": "A lightweight, extensible dependency injection container for JavaScript.",
"keywords": [
"aurelia",
Expand Down
13 changes: 0 additions & 13 deletions build/args.js

This file was deleted.

65 changes: 0 additions & 65 deletions build/babel-options.js

This file was deleted.

32 changes: 0 additions & 32 deletions build/paths.js

This file was deleted.

0 comments on commit e5e277d

Please sign in to comment.