mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
chore!: replace taffydb package with @jsdoc/salty
For context, see https://github.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty.
This commit is contained in:
Jeff Williams
parent
dc48aa6c54
commit
b018408d58
@ -3,10 +3,10 @@ charset = utf-8
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[package.json]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[{**/*.js,**/*.css,**/*.json}]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[package.json,**/*.md]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
@ -9,7 +9,7 @@ Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.
|
||||
Installation and Usage
|
||||
----------------------
|
||||
|
||||
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
|
||||
JSDoc supports stable versions of Node.js 12.0.0 and later. You can install
|
||||
JSDoc globally or in your project's `node_modules` folder.
|
||||
|
||||
To install the latest version on npm globally (might require `sudo`;
|
||||
|
||||
2
cli.js
2
cli.js
@ -413,7 +413,7 @@ module.exports = (() => {
|
||||
cli.generateDocs = () => {
|
||||
const path = require('jsdoc/path');
|
||||
const resolver = require('jsdoc/tutorial/resolver');
|
||||
const taffy = require('taffydb').taffy;
|
||||
const { taffy } = require('@jsdoc/salty');
|
||||
|
||||
let template;
|
||||
|
||||
|
||||
43
package-lock.json
generated
43
package-lock.json
generated
@ -10,6 +10,7 @@
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {
|
||||
"@babel/parser": "^7.9.4",
|
||||
"@jsdoc/salty": "^0.2.1",
|
||||
"@types/markdown-it": "^12.2.3",
|
||||
"bluebird": "^3.7.2",
|
||||
"catharsis": "^0.9.0",
|
||||
@ -22,7 +23,6 @@
|
||||
"mkdirp": "^1.0.4",
|
||||
"requizzle": "^0.2.3",
|
||||
"strip-json-comments": "^3.1.0",
|
||||
"taffydb": "2.6.2",
|
||||
"underscore": "~1.13.2"
|
||||
},
|
||||
"bin": {
|
||||
@ -430,6 +430,17 @@
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/@jsdoc/salty": {
|
||||
"version": "0.2.1",
|
||||
"resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.1.tgz",
|
||||
"integrity": "sha512-JXwylDNSHa549N9uceDYu8D4GMXwSo3H8CCPYEQqxhhHpxD28+lRl2b3bS/caaPj5w1YD3SWtrficJNTnUjGpg==",
|
||||
"dependencies": {
|
||||
"lodash": "^4.17.21"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=v12.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/color-name": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz",
|
||||
@ -4164,9 +4175,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/minimatch": {
|
||||
"version": "3.0.4",
|
||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
|
||||
"integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
|
||||
"integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"brace-expansion": "^1.1.7"
|
||||
@ -6097,11 +6108,6 @@
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/taffydb": {
|
||||
"version": "2.6.2",
|
||||
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
|
||||
"integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg="
|
||||
},
|
||||
"node_modules/test-exclude": {
|
||||
"version": "6.0.0",
|
||||
"resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz",
|
||||
@ -7165,6 +7171,14 @@
|
||||
"integrity": "sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw==",
|
||||
"dev": true
|
||||
},
|
||||
"@jsdoc/salty": {
|
||||
"version": "0.2.1",
|
||||
"resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.1.tgz",
|
||||
"integrity": "sha512-JXwylDNSHa549N9uceDYu8D4GMXwSo3H8CCPYEQqxhhHpxD28+lRl2b3bS/caaPj5w1YD3SWtrficJNTnUjGpg==",
|
||||
"requires": {
|
||||
"lodash": "^4.17.21"
|
||||
}
|
||||
},
|
||||
"@types/color-name": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz",
|
||||
@ -10161,9 +10175,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"minimatch": {
|
||||
"version": "3.0.4",
|
||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
|
||||
"integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
|
||||
"integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"brace-expansion": "^1.1.7"
|
||||
@ -11696,11 +11710,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"taffydb": {
|
||||
"version": "2.6.2",
|
||||
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
|
||||
"integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg="
|
||||
},
|
||||
"test-exclude": {
|
||||
"version": "6.0.0",
|
||||
"resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz",
|
||||
|
||||
17
package.json
17
package.json
@ -14,6 +14,7 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/parser": "^7.9.4",
|
||||
"@jsdoc/salty": "^0.2.1",
|
||||
"@types/markdown-it": "^12.2.3",
|
||||
"bluebird": "^3.7.2",
|
||||
"catharsis": "^0.9.0",
|
||||
@ -26,7 +27,6 @@
|
||||
"mkdirp": "^1.0.4",
|
||||
"requizzle": "^0.2.3",
|
||||
"strip-json-comments": "^3.1.0",
|
||||
"taffydb": "2.6.2",
|
||||
"underscore": "~1.13.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
@ -36,16 +36,6 @@
|
||||
"gulp-json-editor": "^2.5.6",
|
||||
"nyc": "^15.1.0"
|
||||
},
|
||||
"resolutions": {
|
||||
"ansi-regex": "5.0.1",
|
||||
"fsevents": "2.3.2",
|
||||
"glob-parent": "6.0.2",
|
||||
"ini": "1.3.6",
|
||||
"set-value": "4.0.1",
|
||||
"tar": "6.1.11",
|
||||
"trim-newlines": "4.0.2",
|
||||
"trim-off-newlines": "1.0.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12.0.0"
|
||||
},
|
||||
@ -55,11 +45,6 @@
|
||||
"bin": {
|
||||
"jsdoc": "./jsdoc.js"
|
||||
},
|
||||
"greenkeeper": {
|
||||
"ignore": [
|
||||
"taffydb"
|
||||
]
|
||||
},
|
||||
"bugs": "https://github.com/jsdoc/jsdoc/issues",
|
||||
"author": {
|
||||
"name": "Michael Mathews",
|
||||
|
||||
@ -1,6 +1,3 @@
|
||||
The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/).
|
||||
|
||||
|
||||
## Generating Typeface Fonts
|
||||
|
||||
The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:
|
||||
|
||||
@ -4,7 +4,7 @@ const fs = require('jsdoc/fs');
|
||||
const helper = require('jsdoc/util/templateHelper');
|
||||
const logger = require('jsdoc/util/logger');
|
||||
const path = require('jsdoc/path');
|
||||
const taffy = require('taffydb').taffy;
|
||||
const { taffy } = require('@jsdoc/salty');
|
||||
const template = require('jsdoc/template');
|
||||
const util = require('util');
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ describe("jsdoc/util/templateHelper", () => {
|
||||
const helper = require('jsdoc/util/templateHelper');
|
||||
const logger = require('jsdoc/util/logger');
|
||||
const resolver = require('jsdoc/tutorial/resolver');
|
||||
const taffy = require('taffydb').taffy;
|
||||
const { taffy } = require('@jsdoc/salty');
|
||||
|
||||
helper.registerLink('test', 'path/to/test.html');
|
||||
|
||||
@ -558,8 +558,7 @@ describe("jsdoc/util/templateHelper", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// we can't use toEqual() because TaffyDB adds its own stuff to the array it returns.
|
||||
// instead, we make sure arrays a and b are the same length, and that each object in
|
||||
// Make sure arrays a and b are the same length, and that each object in
|
||||
// array b has all the properties of the corresponding object in array a
|
||||
// used for getMembers and prune tests.
|
||||
function compareObjectArrays(a, b) {
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user