@stdlib/datasets-fivethirtyeight-ffq-cli 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2023 The Stdlib Authors.
1
+ Copyright (c) 2016-2024 The Stdlib Authors.
package/README.md CHANGED
@@ -164,7 +164,7 @@ For more information on the project, filing bug reports and feature requests, an
164
164
 
165
165
  ## Copyright
166
166
 
167
- Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
167
+ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
168
168
 
169
169
  </section>
170
170
 
@@ -177,8 +177,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
177
177
  [npm-image]: http://img.shields.io/npm/v/@stdlib/datasets-fivethirtyeight-ffq-cli.svg
178
178
  [npm-url]: https://npmjs.org/package/@stdlib/datasets-fivethirtyeight-ffq-cli
179
179
 
180
- [test-image]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml/badge.svg?branch=v0.1.0
181
- [test-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml?query=branch:v0.1.0
180
+ [test-image]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml/badge.svg?branch=v0.2.1
181
+ [test-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/actions/workflows/test.yml?query=branch:v0.2.1
182
182
 
183
183
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/datasets-fivethirtyeight-ffq/main.svg
184
184
  [coverage-url]: https://codecov.io/github/stdlib-js/datasets-fivethirtyeight-ffq?branch=main
@@ -205,8 +205,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
205
205
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
206
206
 
207
207
  [deno-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/tree/deno
208
+ [deno-readme]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/blob/deno/README.md
208
209
  [umd-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/tree/umd
210
+ [umd-readme]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/blob/umd/README.md
209
211
  [esm-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/tree/esm
212
+ [esm-readme]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/blob/esm/README.md
210
213
  [branches-url]: https://github.com/stdlib-js/datasets-fivethirtyeight-ffq/blob/main/branches.md
211
214
 
212
215
  [odc-by-1.0]: http://opendatacommons.org/licenses/by/1.0/
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/datasets-fivethirtyeight-ffq-cli",
3
- "version": "0.1.0",
3
+ "version": "0.2.1",
4
4
  "description": "FiveThirtyEight reader responses to a food frequency questionnaire (FFQ).",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -25,19 +25,11 @@
25
25
  "url": "https://github.com/stdlib-js/stdlib/issues"
26
26
  },
27
27
  "dependencies": {
28
- "@stdlib/cli-ctor": "^0.1.0",
29
- "@stdlib/fs-read-file": "^0.1.0",
30
- "@stdlib/streams-node-stdout": "^0.1.0"
31
- },
32
- "devDependencies": {
33
- "@stdlib/assert-is-browser": "^0.1.0",
34
- "@stdlib/assert-is-windows": "^0.1.0",
35
- "@stdlib/process-exec-path": "^0.1.0",
36
- "proxyquire": "^2.0.0",
37
- "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
38
- "istanbul": "^0.4.1",
39
- "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
28
+ "@stdlib/cli-ctor": "^0.2.1",
29
+ "@stdlib/fs-read-file": "^0.2.1",
30
+ "@stdlib/streams-node-stdout": "^0.2.1"
40
31
  },
32
+ "devDependencies": {},
41
33
  "keywords": [
42
34
  "stdlib",
43
35
  "datasets",
@@ -1,165 +0,0 @@
1
- #/
2
- # @license Apache-2.0
3
- #
4
- # Copyright (c) 2023 The Stdlib Authors.
5
- #
6
- # Licensed under the Apache License, Version 2.0 (the "License");
7
- # you may not use this file except in compliance with the License.
8
- # You may obtain a copy of the License at
9
- #
10
- # http://www.apache.org/licenses/LICENSE-2.0
11
- #
12
- # Unless required by applicable law or agreed to in writing, software
13
- # distributed under the License is distributed on an "AS IS" BASIS,
14
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- # See the License for the specific language governing permissions and
16
- # limitations under the License.
17
- #/
18
-
19
- # Workflow name:
20
- name: publish_cli
21
-
22
- # Workflow triggers:
23
- on:
24
- # Allow the workflow to be manually run:
25
- workflow_dispatch:
26
- # Workflow inputs:
27
- inputs:
28
- version:
29
- description: 'Version Increment'
30
- type: choice
31
- default: 'none'
32
- options:
33
- - 'none'
34
- - 'major'
35
- - 'minor'
36
- - 'patch'
37
- - 'premajor'
38
- - 'preminor'
39
- - 'prepatch'
40
- - 'prerelease'
41
-
42
- # Workflow jobs:
43
- jobs:
44
-
45
- # Define job to publish package to npm:
46
- publish:
47
-
48
- # Define display name:
49
- name: 'Publish CLI package to npm'
50
-
51
- # Define the type of virtual host machine on which to run the job:
52
- runs-on: ubuntu-latest
53
-
54
- # Define environment variables:
55
- env:
56
- SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
57
- NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
58
-
59
- # Define the sequence of job steps...
60
- steps:
61
-
62
- # Checkout cli branch:
63
- - name: 'Checkout cli branch'
64
- uses: actions/checkout@v3
65
- with:
66
- ref: cli
67
-
68
- # Install Node.js:
69
- - name: 'Install Node.js'
70
- uses: actions/setup-node@v3
71
- with:
72
- node-version: 16
73
- timeout-minutes: 5
74
-
75
- # Configure git:
76
- - name: 'Configure git'
77
- run: |
78
- git config --local user.email "noreply@stdlib.io"
79
- git config --local user.name "stdlib-bot"
80
-
81
- # Increment package version (if requested):
82
- - name: 'Increment package version (if requested)'
83
- if: ${{ github.event.inputs.version != 'none' }}
84
- run: |
85
- # Save NPM_TOKEN to user's .npmrc:
86
- echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
87
-
88
- # Increment package version:
89
- npm version ${{ github.event.inputs.version }} --no-git-tag-version
90
-
91
- # Define variable for new version:
92
- NEW_VERSION=$(node -p "require('./package.json').version")
93
-
94
- # Replace branch in README.md link definitions for badges with the new version:
95
- find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g"
96
-
97
- # Create a new commit and tag:
98
- git add package.json README.md
99
- git commit -m "Release v${NEW_VERSION}"
100
- git tag -a "v${NEW_VERSION}-cli" -m "Release v${NEW_VERSION}"
101
-
102
- # Push changes to GitHub:
103
- SLUG=${{ github.repository }}
104
- git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" --follow-tags
105
-
106
- # Replace GitHub MathJax equations with SVGs:
107
- - name: 'Replace GitHub MathJax equations with SVGs'
108
- run: |
109
- find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g'
110
- find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/<!-- <div class="equation"(.*)(<\/div>\s*-->)/<div class="equation"$1<\/div>/sg'
111
-
112
- # Replace GitHub links to individual packages with npm links:
113
- - name: 'Replace all GitHub links to individual packages with npm links'
114
- run: |
115
- find . -type f -name '*.md' -print0 | xargs -0 sed -Ei '/tree\/main/b; s/@stdlib\/([^:]*)\]: https:\/\/github.com\/stdlib-js/@stdlib\/\1\]: https:\/\/www.npmjs.com\/package\/@stdlib/g'
116
- SLUG=${{ github.repository }}
117
- ESCAPED_SLUG=${SLUG//\//\\\/}
118
- REPO=${SLUG#*/}
119
- find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/https:\/\/github.com\/${ESCAPED_SLUG}\/tree\/main/https:\/\/www.npmjs.com\/package\/@stdlib\/${REPO}/g"
120
-
121
- # Publish package to npm:
122
- - name: 'Publish package to npm'
123
- uses: JS-DevTools/npm-publish@v2
124
- with:
125
- token: ${{ secrets.NPM_TOKEN }}
126
- access: public
127
-
128
- # Discard any uncommitted changes:
129
- - name: 'Discard any uncommitted changes'
130
- run: |
131
- git reset --hard
132
-
133
- # Send status to Slack channel if job fails:
134
- - name: 'Send status to Slack channel in case of failure'
135
- uses: act10ns/slack@v2
136
- with:
137
- status: ${{ job.status }}
138
- steps: ${{ toJson(steps) }}
139
- channel: '#npm-ci'
140
- if: failure()
141
-
142
- # Define job to cancel any running or queued workflow runs...
143
- cancel:
144
-
145
- # Define the type of virtual host machine on which to run the job:
146
- runs-on: ubuntu-latest
147
-
148
- # Time out the job after 3 minutes:
149
- timeout-minutes: 3
150
-
151
- # Define the sequence of job steps...
152
- steps:
153
-
154
- # Cancel any running or queued workflow runs:
155
- - name: 'Cancel running or queued workflow runs'
156
- uses: styfle/cancel-workflow-action@0.11.0
157
- with:
158
- workflow_id: >-
159
- benchmark.yml,
160
- examples.yml,
161
- test.yml,
162
- test_coverage.yml,
163
- test_install.yml,
164
- publish.yml
165
- access_token: ${{ github.token }}
package/CONTRIBUTORS DELETED
@@ -1,39 +0,0 @@
1
- # This file is generated by tools/scripts/update_contributors.
2
- #
3
- # Contributors listed in alphabetical order.
4
-
5
- Ali Salesi <ali_sal1381@yahoo.com>
6
- Amit Jimiwal <amitjimiwal45@gmail.com>
7
- Athan Reines <kgryte@gmail.com>
8
- Brendan Graetz <bguiz@users.noreply.github.com>
9
- Bruno Fenzl <brunofenzl@gmail.com>
10
- Christopher Dambamuromo <chridam@gmail.com>
11
- Dan Rose <danoftheroses@gmail.com>
12
- Dominik Moritz <domoritz@gmail.com>
13
- Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
14
- Frank Kovacs <fran70kk@gmail.com>
15
- Harshita Kalani <harshitakalani02@gmail.com>
16
- James Gelok <jdgelok@gmail.com>
17
- Jithin KS <jithinks112@gmail.com>
18
- Joey Reed <joeyrreed@gmail.com>
19
- Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
20
- Joris Labie <joris.labie1@gmail.com>
21
- Justin Dennison <justin1dennison@gmail.com>
22
- Marcus Fantham <mfantham@users.noreply.github.com>
23
- Matt Cochrane <matthew.cochrane.eng@gmail.com>
24
- Milan Raj <rajsite@users.noreply.github.com>
25
- Momtchil Momtchev <momtchil@momtchev.com>
26
- Naresh Jagadeesan <naresh.naresh000@gmail.com>
27
- Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
28
- Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
29
- Philipp Burckhardt <pburckhardt@outlook.com>
30
- Pranav Goswami <goswami.4@iitj.ac.in>
31
- Ricky Reusser <rsreusser@gmail.com>
32
- Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
33
- Ryan Seal <splrk@users.noreply.github.com>
34
- Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
35
- Shraddheya Shendre <shendreshraddheya@gmail.com>
36
- Stephannie Jiménez Gacha <steff456@hotmail.com>
37
- Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
38
- orimiles5 <97595296+orimiles5@users.noreply.github.com>
39
- rei2hu <reimu@reimu.ws>
package/test/test.cli.js DELETED
@@ -1,172 +0,0 @@
1
- /**
2
- * @license Apache-2.0
3
- *
4
- * Copyright (c) 2019 The Stdlib Authors.
5
- *
6
- * Licensed under the Apache License, Version 2.0 (the "License");
7
- * you may not use this file except in compliance with the License.
8
- * You may obtain a copy of the License at
9
- *
10
- * http://www.apache.org/licenses/LICENSE-2.0
11
- *
12
- * Unless required by applicable law or agreed to in writing, software
13
- * distributed under the License is distributed on an "AS IS" BASIS,
14
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- * See the License for the specific language governing permissions and
16
- * limitations under the License.
17
- */
18
-
19
- 'use strict';
20
-
21
- // MODULES //
22
-
23
- var resolve = require( 'path' ).resolve;
24
- var exec = require( 'child_process' ).exec;
25
- var tape = require( 'tape' );
26
- var IS_BROWSER = require( '@stdlib/assert-is-browser' );
27
- var IS_WINDOWS = require( '@stdlib/assert-is-windows' );
28
- var EXEC_PATH = require( '@stdlib/process-exec-path' );
29
- var readFileSync = require( '@stdlib/fs-read-file' ).sync;
30
-
31
-
32
- // VARIABLES //
33
-
34
- var fpath = resolve( __dirname, '..', 'bin', 'cli' );
35
- var opts = {
36
- 'skip': IS_BROWSER || IS_WINDOWS
37
- };
38
-
39
-
40
- // FIXTURES //
41
-
42
- var PKG_VERSION = require( './../package.json' ).version;
43
-
44
-
45
- // TESTS //
46
-
47
- tape( 'command-line interface', function test( t ) {
48
- t.ok( true, __filename );
49
- t.end();
50
- });
51
-
52
- tape( 'when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
53
- var expected;
54
- var cmd;
55
-
56
- expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
57
- 'encoding': 'utf8'
58
- });
59
- cmd = [
60
- EXEC_PATH,
61
- fpath,
62
- '--help'
63
- ];
64
-
65
- exec( cmd.join( ' ' ), done );
66
-
67
- function done( error, stdout, stderr ) {
68
- if ( error ) {
69
- t.fail( error.message );
70
- } else {
71
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
72
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
73
- }
74
- t.end();
75
- }
76
- });
77
-
78
- tape( 'when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
79
- var expected;
80
- var cmd;
81
-
82
- expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
83
- 'encoding': 'utf8'
84
- });
85
- cmd = [
86
- EXEC_PATH,
87
- fpath,
88
- '-h'
89
- ];
90
-
91
- exec( cmd.join( ' ' ), done );
92
-
93
- function done( error, stdout, stderr ) {
94
- if ( error ) {
95
- t.fail( error.message );
96
- } else {
97
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
98
- t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
99
- }
100
- t.end();
101
- }
102
- });
103
-
104
- tape( 'when invoked with a `--version` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
105
- var cmd = [
106
- EXEC_PATH,
107
- fpath,
108
- '--version'
109
- ];
110
-
111
- exec( cmd.join( ' ' ), done );
112
-
113
- function done( error, stdout, stderr ) {
114
- if ( error ) {
115
- t.fail( error.message );
116
- } else {
117
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
118
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
119
- }
120
- t.end();
121
- }
122
- });
123
-
124
- tape( 'when invoked with a `-V` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
125
- var cmd = [
126
- EXEC_PATH,
127
- fpath,
128
- '-V'
129
- ];
130
-
131
- exec( cmd.join( ' ' ), done );
132
-
133
- function done( error, stdout, stderr ) {
134
- if ( error ) {
135
- t.fail( error.message );
136
- } else {
137
- t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
138
- t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
139
- }
140
- t.end();
141
- }
142
- });
143
-
144
- tape( 'the command-line interface prints FiveThirtyEight reader responses to a food frequency questionnaire (FFQ)', opts, function test( t ) {
145
- var expected;
146
- var opts;
147
- var cmd;
148
-
149
- cmd = [
150
- EXEC_PATH,
151
- fpath
152
- ];
153
-
154
- expected = readFileSync( resolve( __dirname, '..', 'data', 'data.csv' ) );
155
-
156
- opts = {
157
- 'maxBuffer': 10 * 1024 * 1024
158
- };
159
- exec( cmd.join( ' ' ), opts, done );
160
-
161
- function done( error, stdout, stderr ) {
162
- if ( error ) {
163
- t.fail( error.message );
164
- } else {
165
- stdout = stdout.toString();
166
- expected = expected.toString();
167
- t.strictEqual( stdout, expected, 'prints data' );
168
- t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
169
- }
170
- t.end();
171
- }
172
- });