Skip to content

Commit d96cc93

Browse files
stuartherbertstuartherbert
committed
Initial commit
0 parents  commit d96cc93

27 files changed

+668
-0
lines changed

‎.eslintrc.js

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
module.exports = {
2+
"env": {
3+
"browser": true,
4+
"commonjs": true,
5+
"es6": true
6+
},
7+
"extends": "eslint:recommended",
8+
"parserOptions": {
9+
"ecmaVersion": 2018,
10+
"sourceType": "module"
11+
},
12+
"rules": {
13+
"indent": [
14+
"error",
15+
4
16+
],
17+
"linebreak-style": [
18+
"error",
19+
"unix"
20+
],
21+
"quotes": [
22+
"error",
23+
"double"
24+
],
25+
"semi": [
26+
"error",
27+
"always"
28+
]
29+
}
30+
};

‎.github/workflows/nodejs.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
3+
4+
name: Node.js CI
5+
6+
on:
7+
push:
8+
branches:
9+
- master
10+
- develop
11+
- 'release/**'
12+
- 'hotfix/**'
13+
- 'support/**'
14+
pull_request:
15+
branches:
16+
- develop
17+
- master
18+
- 'support/**'
19+
20+
jobs:
21+
build:
22+
23+
runs-on: ubuntu-latest
24+
25+
strategy:
26+
matrix:
27+
node-version: [12.x]
28+
29+
steps:
30+
- uses: actions/checkout@v2
31+
- name: Use Node.js ${{ matrix.node-version }}
32+
uses: actions/setup-node@v1
33+
with:
34+
node-version: ${{ matrix.node-version }}
35+
- run: npm ci
36+
- run: npm run build --if-present
37+
- run: npm run cover
38+
env:
39+
CI: true

‎.github/workflows/npmpublish.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
3+
4+
name: Node.js Package
5+
6+
on:
7+
push:
8+
tags: '**'
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [12.x]
17+
18+
steps:
19+
- uses: actions/checkout@v2
20+
- name: Use Node.js ${{ matrix.node-version }}
21+
uses: actions/setup-node@v1
22+
with:
23+
node-version: ${{ matrix.node-version }}
24+
registry-url: https://registry.npmjs.org/
25+
- run: npm ci
26+
- run: npm run build --if-present
27+
- run: npm run cover
28+
env:
29+
CI: true
30+
- run: npm publish
31+
env:
32+
NODE_AUTH_TOKEN: ${{secrets.npm_token}}

‎.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.nyc_output
2+
.vscode
3+
coverage
4+
index.js
5+
index.js.map
6+
src/**/*.d.ts
7+
src/**/*.map
8+
lib
9+
node_modules
10+
tmp

‎.nycrc.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"extension": [
3+
".ts"
4+
],
5+
"exclude": [
6+
"**/*.d.ts",
7+
"**/*.spec.ts",
8+
"**/*.spec.js",
9+
"coverage/**",
10+
"spec/**"
11+
],
12+
"reporter": [
13+
"json",
14+
"html",
15+
"text"
16+
],
17+
"all": false
18+
}

‎.yo-safelytyped.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"githubOrg": "SafelyTyped",
3+
"repoName": "ts-datalocations",
4+
"packageName": "@safelytyped/datalocations",
5+
"copyrightHolder": "Ganbaro Digital Ltd",
6+
"copyrightWebsite": "https://ganbarodigital.com",
7+
"packageContactEmail": "[email protected]",
8+
"license": "BSD-3-Clause",
9+
"copyrightYear": 2020,
10+
"packageDescription": "Safe types for file paths and remote data locations",
11+
"npmLicense": "BSD-3-Clause",
12+
"branchingModel": "gitflow"
13+
}

‎AUTHORS.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AUTHORS
2+
3+
## Current Maintainers
4+
5+
This library is currently maintained by:
6+
7+
* Stuart Herbert <[email protected]> (https://ganbarodigital.com)
8+
9+
## Previous Maintainers
10+
11+
This library was previously maintained by:
12+
13+
* none
14+
15+
## Contributors
16+
17+
This library includes contributions by:
18+
19+
* none

‎CHANGELOG.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# CHANGELOG
2+
3+
## Introduction
4+
5+
This CHANGELOG tells you:
6+
7+
* when a release was made
8+
* what is in each release
9+
10+
It also tells you what changes have been completed, and will be included in the next tagged release.
11+
12+
For each release, changes are grouped under these headings:
13+
14+
* _Backwards-Compatibility Breaks_: a list of any backwards-compatibility breaks
15+
* _New_: a list of new features. If the feature came from a contributor via a PR, make sure you link to the PR and give them a mention here.
16+
* _Fixes_: a list of bugs that have been fixed. If there's an issue for the bug, make sure you link to the GitHub issue here.
17+
* _Dependencies_: a list of dependencies that have been added / updated / removed.
18+
* _Tools_: a list of bundled tools that have been added / updated / removed.
19+
20+
## develop branch
21+
22+
The following changes have been completed, and will be included in the next tagged release.
23+
24+
### Backwards-Compatibility Breaks
25+
26+
### New
27+
28+
### Fixes
29+
30+
### Dependencies
31+
32+
### Tools
33+
34+
## v0.0.1
35+
36+
Released Monday, 1st January 2020.
37+
38+
### Backwards-Compatibility Breaks
39+
40+
### New
41+
42+
### Fixes
43+
44+
### Dependencies
45+
46+
### Tools

‎CODE-OF-CONDUCT.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Code of Conduct
2+
3+
## Our Code Of Conduct
4+
5+
As contributors and maintainers of this project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.
6+
7+
Communication through any of the project's channels (GitHub, IRC, mailing lists, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harrassment, insults, or other unprofessional conduct.
8+
9+
We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to this project to do the same.
10+
11+
If any member of the community violates this code of conduct, the maintainers of the project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.
12+
13+
If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at [email protected].

‎CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
Are you looking to contribute to this project? You'll find all of our documentation on that in [docs/contributors](./docs/contributors) and [docs/maintainers](./docs/maintainers).

‎LICENSE.md

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

‎MAINTAINERS.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# MAINTAINERS
2+
3+
Are you looking to work on this project? You'll find all the relevant documention in [docs/maintainers](./docs/maintainers).

‎README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Welcome To @safelytyped/datalocations!
2+
3+
## Introduction
4+
5+
ADD YOUR INTRODUCTION HERE!!
6+
7+
## Quick Start
8+
9+
```
10+
# run this from your Terminal
11+
npm install @safelytyped/datalocations
12+
```
13+
14+
```typescript
15+
// add this import to your Typescript code
16+
import { Value } from "@safelytyped/datalocations"
17+
```
18+
19+
__VS Code users:__ once you've added a single import anywhere in your project, you'll then be able to auto-import anything else that this library exports.
20+
21+
## Documentation
22+
23+
Looking for more detailed documentation? You'll find it under the [docs](./docs) folder.
24+
25+
* [Our CHANGELOG](CHANGELOG.md)
26+
* [Our software license](LICENSE.md)
27+
* [All contributors to date](AUTHORS.md)

‎docs/contributors/00-GETTING-STARTED.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Getting Started
2+
3+
## Fixing Bugs
4+
5+
Is there an open [issue][issues] for the bug? Please check first.
6+
7+
* If there isn't, please open an issue. We need somewhere for us all to discuss the bug and agree on what the fix should be.
8+
* If there is, please don't open a new issue. Use the existing issue to discuss the fix you want to merge in.
9+
10+
Please make sure your pull request mentions which issue(s) it fixes.
11+
12+
## Submitting A New Feature
13+
14+
Please check our [issues][issues] list first. Is there an existing issue that covers your new feature? If not, please open a new issue, so that we've got somewhere to discuss the feature.
15+
16+
[issues](https://github.com/SafelyTyped/ts-datalocations/issues)

‎docs/contributors/CODING-STANDARDS.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Coding Standards
2+
3+
This project follows the [SafelyTyped Coding Standards][https://github.com/SafelyTyped/ts-coding-standards].
4+
5+
[coding-standards]: https://github.com/SafelyTyped/ts-coding-standards

‎docs/contributors/Pull-Requests.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Pull Requests
2+
3+
## Creating A Pull Request
4+
5+
We need a new pull request for every bugfix or feature that you wish to contribute.
6+
7+
Follow these steps for your features or fixes:
8+
9+
1. if you don't have one already, create an account on Github
10+
2. on Github, fork our project
11+
3. clone your fork to your local computer
12+
4. create a new branch on your local computer: `git checkout -b feature/<my-feature> develop`
13+
5. work on your feature
14+
6. commit it, and push it back up to your fork
15+
16+
When you're ready to submit your pull request, please make sure it's a pull request against our `develop` branch.
17+
18+
## How We'll Check Your Pull Request
19+
20+
This project follows the [SafelyTyped Code Review Guidelines][code-review-guidelines].
21+
22+
We'll check your pull request for the following:
23+
24+
1. does the pull request address a single open GitHub issue?
25+
2. does the pull request apply cleanly against our `develop` branch?
26+
3. does it fit within the existing scope of the library?
27+
4. does it fit our goals for the library?
28+
5. does it meet our [coding standards][coding-standards]?
29+
6. does it come will 100% unit test coverage?
30+
7. does the pull request include updated docs showing how the new feature works?
31+
32+
If the answer is 'no' to any of those, we'll respond and let you know what we need you to do before we can accept your pull request.
33+
34+
## Accepted Contributions
35+
36+
If we accept your pull request, we'll add your details to our [authors](AUTHORS.md) page, so that your contribution is acknowledged. We'll also add details of your change to our [CHANGELOG](CHANGELOG.md) page.
37+
38+
[code-review-guidelines]: https://github.com/SafelyTyped/ts-coding-standards/blob/master/CODE-REVIEW-GUIDELINES.md
39+
[coding-standards]: https://github.com/SafelyTyped/ts-coding-standards
40+
[issues](https://github.com/SafelyTyped/ts-datalocations/issues)

‎docs/maintainers/Branching-Model.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Branching Model
2+
3+
## What Is Our Convention?
4+
5+
This library uses the [Gitflow](http://datasift.github.io/gitflow/) model for managing branches in our Git repository:
6+
7+
Branch | Purpose
8+
-------|--------
9+
`master` | latest tagged release
10+
`develop` | completed features and fixes waiting for final testing and release
11+
`feature/XXX` | work in progress, to be merged into `develop` when completed
12+
`release/XXX` | a release that is undergoing final testing, to be merged into `master` and `develop` when completed
13+
`hotfix/XXX` | emergency bug fixes in progress, to be merged into `master` and released when completed
14+
15+
* Create a new feature branch for each bug fix or new feature.
16+
* Always merge from `develop` into your feature branch right before you create your pull request.
17+
* Create a pull request before merging each feature branch into `develop`.
18+
* Assign the pull request to a milestone in GitHub.
19+
* Always delete the feature branch once the pull request is accepted.
20+
* __Never commit directly to `master`.__
21+
22+
## Rationale
23+
24+
Gitflow makes it easy for multiple people to work on the same code base at the same time. It isolates work-in-progress, and provides a single source of truth for accepted-work.
25+
26+
It also provides a clear history / audit trail through the list of merged pull requests.

0 commit comments

Comments
 (0)