From cf898a98ed2cffd097aa532b2bab9693c60e4681 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Sat, 23 May 2026 22:37:27 +0530 Subject: [PATCH 1/3] feat: add plot/vega/base/grid-aligns --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../plot/vega/base/grid-aligns/README.md | 117 ++++++++++++++++++ .../base/grid-aligns/benchmark/benchmark.js | 48 +++++++ .../plot/vega/base/grid-aligns/docs/repl.txt | 17 +++ .../base/grid-aligns/docs/types/index.d.ts | 35 ++++++ .../vega/base/grid-aligns/docs/types/test.ts | 32 +++++ .../vega/base/grid-aligns/examples/index.js | 40 ++++++ .../plot/vega/base/grid-aligns/lib/data.json | 5 + .../plot/vega/base/grid-aligns/lib/index.js | 40 ++++++ .../plot/vega/base/grid-aligns/lib/main.js | 44 +++++++ .../plot/vega/base/grid-aligns/package.json | 64 ++++++++++ .../plot/vega/base/grid-aligns/test/test.js | 48 +++++++ 11 files changed, 490 insertions(+) create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json create mode 100644 lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md new file mode 100644 index 000000000000..c4af9f61cef4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md @@ -0,0 +1,117 @@ + + +# gridAligns + +> List of supported Vega grid aligns. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' ); +``` + +#### gridAligns() + +Returns a list of grid aligns. + +```javascript +var out = gridAligns(); +// returns [ 'all', 'each', 'none' ] +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```javascript +var contains = require( '@stdlib/array/base/assert/contains' ).factory; +var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' ); + +var isGridAlign = contains( gridAligns() ); + +var bool = isGridAlign( 'all' ); +// returns true + +bool = isGridAlign( 'each' ); +// returns true + +bool = isGridAlign( 'beep' ); +// returns false + +bool = isGridAlign( 'boop' ); +// returns false +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js new file mode 100644 index 000000000000..64e21d0b64c8 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives; +var pkg = require( './../package.json' ).name; +var gridAligns = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = gridAligns(); + if ( out.length < 2 ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( !isStringArray( out ) ) { + b.fail( 'should return an array of strings' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt new file mode 100644 index 000000000000..eb6c75f82da4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt @@ -0,0 +1,17 @@ + +{{alias}}() + Returns a list of grid aligns. + + Returns + ------- + out: Array + List of grid aligns. + + Examples + -------- + > var out = {{alias}}() + [ 'all', 'each', 'none' ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts new file mode 100644 index 000000000000..0dd46529232a --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts @@ -0,0 +1,35 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Returns a list of grid aligns. +* +* @returns list of grid aligns +* +* @example +* var list = gridAligns(); +* // returns [ 'all', 'each', 'none' ] +*/ +declare function gridAligns(): Array; + + +// EXPORTS // + +export = gridAligns; diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts new file mode 100644 index 000000000000..b8006ef3eac9 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts @@ -0,0 +1,32 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import gridAligns = require( './index' ); + + +// TESTS // + +// The function returns an array of strings... +{ + gridAligns(); // $ExpectType string[] +} + +// The compiler throws an error if the function is provided any arguments... +{ + gridAligns( 9 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js new file mode 100644 index 000000000000..64ce795d59bb --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var contains = require( '@stdlib/array/base/assert/contains' ).factory; +var gridAligns = require( './../lib' ); + +var isGridAlign = contains( gridAligns() ); + +var bool = isGridAlign( 'all' ); +console.log( bool ); +// => true + +bool = isGridAlign( 'each' ); +console.log( bool ); +// => true + +bool = isGridAlign( 'beep' ); +console.log( bool ); +// => false + +bool = isGridAlign( 'boop' ); +console.log( bool ); +// => false diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json new file mode 100644 index 000000000000..76cb09905b71 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json @@ -0,0 +1,5 @@ +[ + "all", + "each", + "none" +] diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js new file mode 100644 index 000000000000..f7f248cc7ed4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Return a list of grid aligns. +* +* @module @stdlib/plot/vega/base/grid-aligns +* +* @example +* var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' ); +* +* var out = gridAligns(); +* // returns [ 'all', 'each', 'none' ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js new file mode 100644 index 000000000000..458e064dfddf --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js @@ -0,0 +1,44 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var DATA = require( './data.json' ); + + +// MAIN // + +/** +* Returns a list of grid aligns. +* +* @returns {StringArray} list of grid aligns +* +* @example +* var out = gridAligns(); +* // returns [ 'all', 'each', 'none' ] +*/ +function gridAligns() { + return DATA.slice(); +} + + +// EXPORTS // + +module.exports = gridAligns; diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json new file mode 100644 index 000000000000..de50e6a33f14 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json @@ -0,0 +1,64 @@ +{ + "name": "@stdlib/plot/vega/base/grid-aligns", + "version": "0.0.0", + "description": "List of supported Vega grid aligns.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "plot", + "vega", + "grid", + "align", + "layout", + "utilities", + "utility", + "utils", + "util" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js new file mode 100644 index 000000000000..9d21dd94a53e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var gridAligns = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof gridAligns, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns a list of grid aligns', function test( t ) { + var expected; + var actual; + + expected = [ + 'all', + 'each', + 'none' + ]; + actual = gridAligns(); + + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +}); From 5d74918a292039fd1244876354d7965b178c49c0 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 23 May 2026 17:13:08 +0000 Subject: [PATCH 2/3] chore: update copyright years --- lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md | 2 +- .../@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js | 2 +- .../@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts | 2 +- .../@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts | 2 +- .../@stdlib/plot/vega/base/grid-aligns/examples/index.js | 2 +- .../@stdlib/plot/vega/base/grid-aligns/lib/index.js | 2 +- lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js | 2 +- .../@stdlib/plot/vega/base/grid-aligns/test/test.js | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md index c4af9f61cef4..9a8c8ccd1242 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +Copyright (c) 2026 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js index 64e21d0b64c8..67b0bc9530fd 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts index 0dd46529232a..0a2180f3127a 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts index b8006ef3eac9..4e6cbfd02d1d 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js index 64ce795d59bb..89709f9e84a7 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js index f7f248cc7ed4..67482c3b5e04 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js index 458e064dfddf..916961972bc8 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js index 9d21dd94a53e..884696a23b91 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 01c94ca8b2fb6bbc541d915af65a27c14ed0d215 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 27 May 2026 02:25:23 +0530 Subject: [PATCH 3/3] refactor: naming and conventions --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../README.md | 24 +++++++++---------- .../benchmark/benchmark.js | 4 ++-- .../docs/repl.txt | 4 ++-- .../docs/types/index.d.ts | 10 ++++---- .../docs/types/test.ts | 6 ++--- .../examples/index.js | 12 +++++----- .../lib/data.json | 0 .../lib/index.js | 8 +++---- .../lib/main.js | 10 ++++---- .../package.json | 5 ++-- .../test/test.js | 8 +++---- 11 files changed, 46 insertions(+), 45 deletions(-) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/README.md (81%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/benchmark/benchmark.js (94%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/docs/repl.txt (70%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/docs/types/index.d.ts (80%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/docs/types/test.ts (85%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/examples/index.js (78%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/lib/data.json (100%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/lib/index.js (80%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/lib/main.js (81%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/package.json (90%) rename lib/node_modules/@stdlib/plot/vega/base/{grid-aligns => grid-alignments}/test/test.js (80%) diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/README.md similarity index 81% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/README.md index 9a8c8ccd1242..a24423f893b5 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/README.md +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/README.md @@ -18,9 +18,9 @@ limitations under the License. --> -# gridAligns +# gridAlignments -> List of supported Vega grid aligns. +> List of supported Vega grid alignments. @@ -37,15 +37,15 @@ limitations under the License. ## Usage ```javascript -var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' ); +var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' ); ``` -#### gridAligns() +#### gridAlignments() -Returns a list of grid aligns. +Returns a list of grid alignments. ```javascript -var out = gridAligns(); +var out = gridAlignments(); // returns [ 'all', 'each', 'none' ] ``` @@ -71,20 +71,20 @@ var out = gridAligns(); ```javascript var contains = require( '@stdlib/array/base/assert/contains' ).factory; -var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' ); +var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' ); -var isGridAlign = contains( gridAligns() ); +var isGridAlignment = contains( gridAlignments() ); -var bool = isGridAlign( 'all' ); +var bool = isGridAlignment( 'all' ); // returns true -bool = isGridAlign( 'each' ); +bool = isGridAlignment( 'each' ); // returns true -bool = isGridAlign( 'beep' ); +bool = isGridAlignment( 'beep' ); // returns false -bool = isGridAlign( 'boop' ); +bool = isGridAlignment( 'boop' ); // returns false ``` diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/benchmark/benchmark.js similarity index 94% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/benchmark/benchmark.js index 67b0bc9530fd..44f1b2c53372 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/benchmark/benchmark.js @@ -23,7 +23,7 @@ var bench = require( '@stdlib/bench' ); var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives; var pkg = require( './../package.json' ).name; -var gridAligns = require( './../lib' ); +var gridAlignments = require( './../lib' ); // MAIN // @@ -34,7 +34,7 @@ bench( pkg, function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = gridAligns(); + out = gridAlignments(); if ( out.length < 2 ) { b.fail( 'should return an array' ); } diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/repl.txt similarity index 70% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/repl.txt index eb6c75f82da4..a07c36dd59bf 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/repl.txt @@ -1,11 +1,11 @@ {{alias}}() - Returns a list of grid aligns. + Returns a list of grid alignments. Returns ------- out: Array - List of grid aligns. + List of grid alignments. Examples -------- diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/index.d.ts similarity index 80% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/index.d.ts index 0a2180f3127a..af0f22e1e25b 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/index.d.ts @@ -19,17 +19,17 @@ // TypeScript Version: 4.1 /** -* Returns a list of grid aligns. +* Returns a list of grid alignments. * -* @returns list of grid aligns +* @returns list of grid alignments * * @example -* var list = gridAligns(); +* var list = gridAlignments(); * // returns [ 'all', 'each', 'none' ] */ -declare function gridAligns(): Array; +declare function gridAlignments(): Array; // EXPORTS // -export = gridAligns; +export = gridAlignments; diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/test.ts similarity index 85% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/test.ts index 4e6cbfd02d1d..7959faa6f3a8 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/docs/types/test.ts +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/docs/types/test.ts @@ -16,17 +16,17 @@ * limitations under the License. */ -import gridAligns = require( './index' ); +import gridAlignments = require( './index' ); // TESTS // // The function returns an array of strings... { - gridAligns(); // $ExpectType string[] + gridAlignments(); // $ExpectType string[] } // The compiler throws an error if the function is provided any arguments... { - gridAligns( 9 ); // $ExpectError + gridAlignments( 9 ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/examples/index.js similarity index 78% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/examples/index.js index 89709f9e84a7..7107125971d9 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/examples/index.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/examples/index.js @@ -19,22 +19,22 @@ 'use strict'; var contains = require( '@stdlib/array/base/assert/contains' ).factory; -var gridAligns = require( './../lib' ); +var gridAlignments = require( './../lib' ); -var isGridAlign = contains( gridAligns() ); +var isGridAlignment = contains( gridAlignments() ); -var bool = isGridAlign( 'all' ); +var bool = isGridAlignment( 'all' ); console.log( bool ); // => true -bool = isGridAlign( 'each' ); +bool = isGridAlignment( 'each' ); console.log( bool ); // => true -bool = isGridAlign( 'beep' ); +bool = isGridAlignment( 'beep' ); console.log( bool ); // => false -bool = isGridAlign( 'boop' ); +bool = isGridAlignment( 'boop' ); console.log( bool ); // => false diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/data.json similarity index 100% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/data.json rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/data.json diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/index.js similarity index 80% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/index.js index 67482c3b5e04..586356e8ce4b 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/index.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/index.js @@ -19,14 +19,14 @@ 'use strict'; /** -* Return a list of grid aligns. +* Return a list of grid alignments. * -* @module @stdlib/plot/vega/base/grid-aligns +* @module @stdlib/plot/vega/base/grid-alignments * * @example -* var gridAligns = require( '@stdlib/plot/vega/base/grid-aligns' ); +* var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' ); * -* var out = gridAligns(); +* var out = gridAlignments(); * // returns [ 'all', 'each', 'none' ] */ diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/main.js similarity index 81% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/main.js index 916961972bc8..06fb582c0724 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/lib/main.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/lib/main.js @@ -26,19 +26,19 @@ var DATA = require( './data.json' ); // MAIN // /** -* Returns a list of grid aligns. +* Returns a list of grid alignments. * -* @returns {StringArray} list of grid aligns +* @returns {StringArray} list of grid alignments * * @example -* var out = gridAligns(); +* var out = gridAlignments(); * // returns [ 'all', 'each', 'none' ] */ -function gridAligns() { +function gridAlignments() { return DATA.slice(); } // EXPORTS // -module.exports = gridAligns; +module.exports = gridAlignments; diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/package.json similarity index 90% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/package.json index de50e6a33f14..661d0e8827be 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/package.json +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/package.json @@ -1,7 +1,7 @@ { - "name": "@stdlib/plot/vega/base/grid-aligns", + "name": "@stdlib/plot/vega/base/grid-alignments", "version": "0.0.0", - "description": "List of supported Vega grid aligns.", + "description": "List of supported Vega grid alignments.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -53,6 +53,7 @@ "plot", "vega", "grid", + "alignment", "align", "layout", "utilities", diff --git a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/test/test.js similarity index 80% rename from lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js rename to lib/node_modules/@stdlib/plot/vega/base/grid-alignments/test/test.js index 884696a23b91..fe729e513ce0 100644 --- a/lib/node_modules/@stdlib/plot/vega/base/grid-aligns/test/test.js +++ b/lib/node_modules/@stdlib/plot/vega/base/grid-alignments/test/test.js @@ -21,18 +21,18 @@ // MODULES // var tape = require( 'tape' ); -var gridAligns = require( './../lib' ); +var gridAlignments = require( './../lib' ); // TESTS // tape( 'main export is a function', function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof gridAligns, 'function', 'main export is a function' ); + t.strictEqual( typeof gridAlignments, 'function', 'main export is a function' ); t.end(); }); -tape( 'the function returns a list of grid aligns', function test( t ) { +tape( 'the function returns a list of grid alignments', function test( t ) { var expected; var actual; @@ -41,7 +41,7 @@ tape( 'the function returns a list of grid aligns', function test( t ) { 'each', 'none' ]; - actual = gridAligns(); + actual = gridAlignments(); t.deepEqual( actual, expected, 'returns expected value' ); t.end();