Skip to content

Commit

Permalink
chore!: replace taffydb package with @jsdoc/salty
Browse files Browse the repository at this point in the history
  • Loading branch information
hegemonic committed Nov 3, 2022
1 parent dc48aa6 commit b018408
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 46 deletions.
8 changes: 4 additions & 4 deletions .editorconfig
Expand Up @@ -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
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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`;
Expand Down
2 changes: 1 addition & 1 deletion cli.js
Expand Up @@ -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;

Expand Down
43 changes: 26 additions & 17 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 1 addition & 16 deletions package.json
Expand Up @@ -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",
Expand All @@ -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": {
Expand All @@ -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"
},
Expand All @@ -55,11 +45,6 @@
"bin": {
"jsdoc": "./jsdoc.js"
},
"greenkeeper": {
"ignore": [
"taffydb"
]
},
"bugs": "https://github.com/jsdoc/jsdoc/issues",
"author": {
"name": "Michael Mathews",
Expand Down
3 changes: 0 additions & 3 deletions templates/default/README.md
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion templates/default/publish.js
Expand Up @@ -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');

Expand Down
5 changes: 2 additions & 3 deletions test/specs/jsdoc/util/templateHelper.js
Expand Up @@ -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');

Expand Down Expand Up @@ -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) {
Expand Down

0 comments on commit b018408

Please sign in to comment.