Added scaffolding for version notification data service
refs https://github.com/TryGhost/Toolbox/issues/292 - This will be filled up with version nofitication data access logic
This commit is contained in:
parent
12f823c677
commit
38dc003258
6
ghost/version-notifications-data-service/.eslintrc.js
Normal file
6
ghost/version-notifications-data-service/.eslintrc.js
Normal file
@ -0,0 +1,6 @@
|
||||
module.exports = {
|
||||
plugins: ['ghost'],
|
||||
extends: [
|
||||
'plugin:ghost/node'
|
||||
]
|
||||
};
|
21
ghost/version-notifications-data-service/LICENSE
Normal file
21
ghost/version-notifications-data-service/LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2013-2022 Ghost Foundation
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
41
ghost/version-notifications-data-service/README.md
Normal file
41
ghost/version-notifications-data-service/README.md
Normal file
@ -0,0 +1,41 @@
|
||||
# Version Notifications Data Service
|
||||
|
||||
Package-service managing data fot the version notification service
|
||||
|
||||
## Install
|
||||
|
||||
`npm install @tryghost/version-notifications-data-service --save`
|
||||
|
||||
or
|
||||
|
||||
`yarn add @tryghost/version-notifications-data-service`
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
## Develop
|
||||
|
||||
This is a mono repository, managed with [lerna](https://lernajs.io/).
|
||||
|
||||
Follow the instructions for the top-level repo.
|
||||
1. `git clone` this repo & `cd` into it as usual
|
||||
2. Run `yarn` to install top-level dependencies.
|
||||
|
||||
|
||||
## Run
|
||||
|
||||
- `yarn dev`
|
||||
|
||||
|
||||
## Test
|
||||
|
||||
- `yarn lint` run just eslint
|
||||
- `yarn test` run lint and tests
|
||||
|
||||
|
||||
|
||||
|
||||
# Copyright & License
|
||||
|
||||
Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).
|
1
ghost/version-notifications-data-service/index.js
Normal file
1
ghost/version-notifications-data-service/index.js
Normal file
@ -0,0 +1 @@
|
||||
module.exports = require('./lib/version-notifications-data-service');
|
30
ghost/version-notifications-data-service/package.json
Normal file
30
ghost/version-notifications-data-service/package.json
Normal file
@ -0,0 +1,30 @@
|
||||
{
|
||||
"name": "@tryghost/version-notifications-data-service",
|
||||
"version": "0.0.0",
|
||||
"repository": "https://github.com/TryGhost/Utils/tree/main/packages/version-notifications-data-service",
|
||||
"author": "Ghost Foundation",
|
||||
"license": "MIT",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"dev": "echo \"Implement me!\"",
|
||||
"test": "NODE_ENV=testing c8 --all --check-coverage --reporter text --reporter cobertura mocha './test/**/*.test.js'",
|
||||
"lint:code": "eslint *.js lib/ --ext .js --cache",
|
||||
"lint": "yarn lint:code && yarn lint:test",
|
||||
"lint:test": "eslint -c test/.eslintrc.js test/ --ext .js --cache",
|
||||
"posttest": "yarn lint"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"lib"
|
||||
],
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"devDependencies": {
|
||||
"c8": "7.11.2",
|
||||
"mocha": "9.2.2",
|
||||
"should": "13.2.3",
|
||||
"sinon": "13.0.2"
|
||||
},
|
||||
"dependencies": {}
|
||||
}
|
@ -0,0 +1,6 @@
|
||||
module.exports = {
|
||||
plugins: ['ghost'],
|
||||
extends: [
|
||||
'plugin:ghost/test'
|
||||
]
|
||||
};
|
@ -0,0 +1,8 @@
|
||||
const assert = require('assert');
|
||||
|
||||
describe('Version Notification Data Service', function () {
|
||||
it('Runs a test', function () {
|
||||
// TODO: Write me!
|
||||
assert.equal('hello', 'hello');
|
||||
});
|
||||
});
|
Loading…
Reference in New Issue
Block a user