Skip to content

Commit b018408

Browse files
committed
chore!: replace taffydb package with @jsdoc/salty
For context, see https://github.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty.
1 parent dc48aa6 commit b018408

File tree

8 files changed

+36
-46
lines changed

8 files changed

+36
-46
lines changed

.editorconfig

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ charset = utf-8
33
insert_final_newline = true
44
trim_trailing_whitespace = true
55

6-
[package.json]
7-
indent_style = space
8-
indent_size = 2
9-
106
[{**/*.js,**/*.css,**/*.json}]
117
indent_style = space
128
indent_size = 4
9+
10+
[package.json,**/*.md]
11+
indent_style = space
12+
indent_size = 2

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.
99
Installation and Usage
1010
----------------------
1111

12-
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
12+
JSDoc supports stable versions of Node.js 12.0.0 and later. You can install
1313
JSDoc globally or in your project's `node_modules` folder.
1414

1515
To install the latest version on npm globally (might require `sudo`;

cli.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ module.exports = (() => {
413413
cli.generateDocs = () => {
414414
const path = require('jsdoc/path');
415415
const resolver = require('jsdoc/tutorial/resolver');
416-
const taffy = require('taffydb').taffy;
416+
const { taffy } = require('@jsdoc/salty');
417417

418418
let template;
419419

package-lock.json

Lines changed: 26 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
},
1515
"dependencies": {
1616
"@babel/parser": "^7.9.4",
17+
"@jsdoc/salty": "^0.2.1",
1718
"@types/markdown-it": "^12.2.3",
1819
"bluebird": "^3.7.2",
1920
"catharsis": "^0.9.0",
@@ -26,7 +27,6 @@
2627
"mkdirp": "^1.0.4",
2728
"requizzle": "^0.2.3",
2829
"strip-json-comments": "^3.1.0",
29-
"taffydb": "2.6.2",
3030
"underscore": "~1.13.2"
3131
},
3232
"devDependencies": {
@@ -36,16 +36,6 @@
3636
"gulp-json-editor": "^2.5.6",
3737
"nyc": "^15.1.0"
3838
},
39-
"resolutions": {
40-
"ansi-regex": "5.0.1",
41-
"fsevents": "2.3.2",
42-
"glob-parent": "6.0.2",
43-
"ini": "1.3.6",
44-
"set-value": "4.0.1",
45-
"tar": "6.1.11",
46-
"trim-newlines": "4.0.2",
47-
"trim-off-newlines": "1.0.3"
48-
},
4939
"engines": {
5040
"node": ">=12.0.0"
5141
},
@@ -55,11 +45,6 @@
5545
"bin": {
5646
"jsdoc": "./jsdoc.js"
5747
},
58-
"greenkeeper": {
59-
"ignore": [
60-
"taffydb"
61-
]
62-
},
6348
"bugs": "https://github.com/jsdoc/jsdoc/issues",
6449
"author": {
6550
"name": "Michael Mathews",

templates/default/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/).
2-
3-
41
## Generating Typeface Fonts
52

63
The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:

templates/default/publish.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const fs = require('jsdoc/fs');
44
const helper = require('jsdoc/util/templateHelper');
55
const logger = require('jsdoc/util/logger');
66
const path = require('jsdoc/path');
7-
const taffy = require('taffydb').taffy;
7+
const { taffy } = require('@jsdoc/salty');
88
const template = require('jsdoc/template');
99
const util = require('util');
1010

test/specs/jsdoc/util/templateHelper.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ describe("jsdoc/util/templateHelper", () => {
1010
const helper = require('jsdoc/util/templateHelper');
1111
const logger = require('jsdoc/util/logger');
1212
const resolver = require('jsdoc/tutorial/resolver');
13-
const taffy = require('taffydb').taffy;
13+
const { taffy } = require('@jsdoc/salty');
1414

1515
helper.registerLink('test', 'path/to/test.html');
1616

@@ -558,8 +558,7 @@ describe("jsdoc/util/templateHelper", () => {
558558
});
559559
});
560560

561-
// we can't use toEqual() because TaffyDB adds its own stuff to the array it returns.
562-
// instead, we make sure arrays a and b are the same length, and that each object in
561+
// Make sure arrays a and b are the same length, and that each object in
563562
// array b has all the properties of the corresponding object in array a
564563
// used for getMembers and prune tests.
565564
function compareObjectArrays(a, b) {

0 commit comments

Comments
 (0)