search

krisk / Fuse

Lightweight fuzzy-search, in JavaScript
https://fusejs.io/
Apache License 2.0
17.79k stars 756 forks source link

Follow JSDoc #570

Closed danisztls closed 2 years ago

danisztls commented 2 years ago

Issue

Currently the documentation header is:

/**
 * Fuse.js v6.4.6 - Lightweight fuzzy-search (http://fusejs.io)
 *
 * Copyright (c) 2021 Kiro Risk (http://kiro.me)
 * All Rights Reserved. Apache Software License 2.0
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 */

It does not follow JSDoc standard which makes bundlers like ESBuild to ignore it.

Suggestions

/**
 * @name     fuseJS
 * @desc     Lightweight fuzzy-search (http://fusejs.io)
 * @author   Kiro Risk (http://kiro.me)
 * @version  6.4.6
 * @license  Apache 2.0
 */

Or simply:

/*!
 * Fuse.js v6.4.6 - Lightweight fuzzy-search (http://fusejs.io)
 *
 * Copyright (c) 2021 Kiro Risk (http://kiro.me)
 * All Rights Reserved. Apache Software License 2.0
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 */
github-actions[bot] commented 2 years ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days