switch to yarn

This commit is contained in:
Timo Hocker 2020-02-05 20:13:43 +01:00
parent 9581fbf2b3
commit 9457505a4c
6 changed files with 1821 additions and 2399 deletions

View File

@ -1 +1 @@
/test/
/test/

2
.npmrc
View File

@ -1 +1 @@
@scode:registry=https://npm.scode.ovh
@scode:registry=https://npm.scode.ovh

92
Jenkinsfile vendored
View File

@ -1,46 +1,46 @@
pipeline {
agent any
environment {
VERSION = VersionNumber([
versionNumberString:
'${BUILDS_ALL_TIME}',
versionPrefix: '1.1.',
worstResultForIncrement: 'SUCCESS'
])
publish = 0
}
stages {
stage('Setup') {
steps {
echo 'Setting up test environment'
sh 'npm ci'
sh 'nodejs jenkins.js ${VERSION}'
script {
currentBuild.displayName = env.VERSION
}
}
}
stage('Testing') {
steps {
echo 'Running tests...'
sh 'npm test'
}
}
}
post {
success {
script {
publish = sh script: "git log -1 | grep '\\[no publish\\]'", returnStatus: true
if (publish != 0) {
echo 'Deploying'
sh 'npm publish'
} else {
echo 'Build successful, Commit not marked for deploying'
currentBuild.result = "UNSTABLE"
}
}
}
}
}
pipeline {
agent any
environment {
VERSION = VersionNumber([
versionNumberString:
'${BUILDS_ALL_TIME}',
versionPrefix: '1.1.',
worstResultForIncrement: 'SUCCESS'
])
publish = 0
}
stages {
stage('Setup') {
steps {
echo 'Setting up test environment'
sh 'yarn --frozen-lockfile'
sh 'nodejs jenkins.js ${VERSION}'
script {
currentBuild.displayName = env.VERSION
}
}
}
stage('Testing') {
steps {
echo 'Running tests...'
sh 'npm test'
}
}
}
post {
success {
script {
publish = sh script: "git log -1 | grep '\\[no publish\\]'", returnStatus: true
if (publish != 0) {
echo 'Deploying'
sh 'yarn publish'
} else {
echo 'Build successful, Commit not marked for deploying'
currentBuild.result = "UNSTABLE"
}
}
}
}
}

140
README.md
View File

@ -1,70 +1,70 @@
# Requestor
Split express request handlers into individual files to make your api a little
more structured.
## Installation
npmrc:
used to set the registry for @scode
```npmrc
@scode:registry=https://npm.scode.ovh
```
install the package:
`npm i --save @scode/requestor`
## Usage
The path to which the individual modules respond is defined by their name.
'.' is used as path separator.
`method-subdir.subdir.subdir.js`
method can be any of [post, get, put, delete, all]
to avoid names like `get-.js` root is used for the root directory
(`get-root.js`)
index.js:
```js
const requestor = require('requestor');
const express = require('express');
const app = express();
requestor(app, 'api', {opts: {foo: 'bar'}});
app.listen(3000);
```
api/get-root.js
```js
// will respond to get requests on /
module.exports = (req, res, next, opts) => {
res.send(opts.foo);
};
```
api/post-subfolder.js
```js
// will respond to post requests on /subfolder/
module.exports = (req, res, next, opts) => {
res.send(opts.foo);
};
```
optionally, you can set a subdirectory for all requests
```js
//...
requestor(app, 'api', {subdir: 'subdir'});
// requests that before responded to /foo/bar/ will now respond to /subdir/foo/bar/
```
# Requestor
Split express request handlers into individual files to make your api a little
more structured.
## Installation
npmrc:
used to set the registry for @scode
```npmrc
@scode:registry=https://npm.scode.ovh
```
install the package:
`npm i --save @scode/requestor`
## Usage
The path to which the individual modules respond is defined by their name.
'.' is used as path separator.
`method-subdir.subdir.subdir.js`
method can be any of [post, get, put, delete, all]
to avoid names like `get-.js` root is used for the root directory
(`get-root.js`)
index.js:
```js
const requestor = require('requestor');
const express = require('express');
const app = express();
requestor(app, 'api', {opts: {foo: 'bar'}});
app.listen(3000);
```
api/get-root.js
```js
// will respond to get requests on /
module.exports = (req, res, next, opts) => {
res.send(opts.foo);
};
```
api/post-subfolder.js
```js
// will respond to post requests on /subfolder/
module.exports = (req, res, next, opts) => {
res.send(opts.foo);
};
```
optionally, you can set a subdirectory for all requests
```js
//...
requestor(app, 'api', {subdir: 'subdir'});
// requests that before responded to /foo/bar/ will now respond to /subdir/foo/bar/
```

2281
package-lock.json generated

File diff suppressed because it is too large Load Diff

1703
yarn.lock Normal file

File diff suppressed because it is too large Load Diff