New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

pluginclerk

Package Overview
Dependencies
Maintainers
2
Versions
60
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pluginclerk - npm Package Compare versions

Comparing version 4.13.0 to 5.0.0-next.1698818712.82ef63ef97f6328ab401de038f86d0ded2fefef5

.prettierignore

380

compiled-types/index.d.ts

@@ -1,226 +0,210 @@

import Cachely from 'cachely'
declare type Versions = {
[name: string]: string | number
}
declare type Ranges = {
[name: string]: string
}
declare type SkippedVersions = {
[name: string]: Versions
}
declare type Person = {
name: string
email?: string
url?: string
}
import Cachely from 'cachely';
type Versions = {
[name: string]: string | number;
};
type Ranges = {
[name: string]: string;
};
type SkippedVersions = {
[name: string]: Versions;
};
type Person = {
name: string;
email?: string;
url?: string;
};
/** @example https://registry.npmjs.org/docpad-plugin-eco */
interface RegistryPackageResult {
_id: string
_rev: string
name: string
description: string
'dist-tags': {
latest: string
}
versions: {
[version: string]: {
name: string
version: string
description: string
homepage: string
license: string
keywords: string[]
author: Person
maintainers: Person[]
contributors: Person[]
bugs: {
url: string
}
repository: {
type: string
url: string
}
engines: Ranges
main: string
dependencies: Versions
devDependencies: Ranges
peerDependencies: Versions
scripts: {
[script: string]: string
}
gitHead: string
_id: string
_shasum?: string
_from?: string
_npmVersion: string
_nodeVersion: string
_npmUser: Person
dist: {
integrity?: string
shasum: string
tarball: string
fileCount?: number
unpackedSize?: number
'npm-signature'?: string
}
directories: object
_npmOperationalInternal: {
host: string
tmp: string
}
}
}
readme: string
maintainers: Person[]
time: {
[version: string]: string
modified: string
created: string
}
author: Person
repository: {
type: string
url: string
}
readmeFilename: string
users: {
[user: string]: boolean
}
homepage: string
keywords: string[]
contributors: Person[]
bugs: {
url: string
}
license: string
_attachments: object
_id: string;
_rev: string;
name: string;
description: string;
'dist-tags': {
latest: string;
};
versions: {
[version: string]: {
name: string;
version: string;
description: string;
homepage: string;
license: string;
keywords: string[];
author: Person;
maintainers: Person[];
contributors: Person[];
bugs: {
url: string;
};
repository: {
type: string;
url: string;
};
engines: Ranges;
main: string;
dependencies: Versions;
devDependencies: Ranges;
peerDependencies: Versions;
scripts: {
[script: string]: string;
};
gitHead: string;
_id: string;
_shasum?: string;
_from?: string;
_npmVersion: string;
_nodeVersion: string;
_npmUser: Person;
dist: {
integrity?: string;
shasum: string;
tarball: string;
fileCount?: number;
unpackedSize?: number;
'npm-signature'?: string;
};
directories: object;
_npmOperationalInternal: {
host: string;
tmp: string;
};
};
};
readme: string;
maintainers: Person[];
time: {
[version: string]: string;
modified: string;
created: string;
};
author: Person;
repository: {
type: string;
url: string;
};
readmeFilename: string;
users: {
[user: string]: boolean;
};
homepage: string;
keywords: string[];
contributors: Person[];
bugs: {
url: string;
};
license: string;
_attachments: object;
}
interface RegistryPackageResults {
[name: string]: RegistryPackageResult
[name: string]: RegistryPackageResult;
}
interface FetchPluginsOptions {
/** specify the dependencies that you require inside the plugin's `package.json` engines or peerDependencies */
requirements?: Versions
/** specify the `package.json` dependencies that you are using to ensure compatibility */
dependencies?: Versions
/** specify the dependencies that you require inside the plugin's `package.json` engines or peerDependencies */
requirements?: Versions;
/** specify the `package.json` dependencies that you are using to ensure compatibility */
dependencies?: Versions;
}
interface PluginsOptions extends FetchPluginsOptions {
/** the database result */
database: RegistryPackageResults
/** the database result */
database: RegistryPackageResults;
}
interface FetchPluginOptions extends FetchPluginsOptions {
/** the name of the package to process the data for */
name: string
/** the name of the package to process the data for */
name: string;
}
interface PluginOptions extends FetchPluginOptions {
/** the database result */
database: RegistryPackageResults
/** the database result */
database: RegistryPackageResults;
}
interface PluginEntry {
/** the description for the plugin */
description: string
/** the homepage for the plugin */
homepage: string
/** the latest version for the plugin */
version: string
/** if {@link PluginOptions} `dependencies` was provided, then this is the getPlugin/fetchPlugin result */
compatibility?: PluginCompatibilityResult
/** the description for the plugin */
description: string;
/** the homepage for the plugin */
homepage: string;
/** the latest version for the plugin */
version: string;
/** if {@link PluginOptions} `dependencies` was provided, then this is the getPlugin/fetchPlugin result */
compatibility?: PluginCompatibilityResult;
}
interface PluginsResult {
/** whether or not the process succeeded */
success: boolean
/** a message about success or failure */
message: string
/** the processed results for each plugin, mapped by plugin name */
plugins: {
[name: string]: PluginEntry
}
/** whether or not the process succeeded */
success: boolean;
/** a message about success or failure */
message: string;
/** the processed results for each plugin, mapped by plugin name */
plugins: {
[name: string]: PluginEntry;
};
}
interface PluginCompatibilityResultBase {
/** whether or not the process succeeded */
success: boolean
/** a message about success or failure */
message: string
/** whether or not the process succeeded */
success: boolean;
/** a message about success or failure */
message: string;
}
interface PluginCompatibilityResultFailure
extends PluginCompatibilityResultBase {
success: false
interface PluginCompatibilityResultFailure extends PluginCompatibilityResultBase {
success: false;
}
interface PluginCompatibilityResultSuccess
extends PluginCompatibilityResultBase {
success: true
/** if there were skipped versions to ensure compatibility, this is a mapping of the skipped version and the cause */
skippedVersions: SkippedVersions
/** this is the latest version available for the package */
latestVersion: string
/** this is the latest compatible version available for the package */
installVersion: string
/** this is an array of peer dependency names that are missing and would need to be installed */
installPeers: string[]
interface PluginCompatibilityResultSuccess extends PluginCompatibilityResultBase {
success: true;
/** if there were skipped versions to ensure compatibility, this is a mapping of the skipped version and the cause */
skippedVersions: SkippedVersions;
/** this is the latest version available for the package */
latestVersion: string;
/** this is the latest compatible version available for the package */
installVersion: string;
/** this is an array of peer dependency names that are missing and would need to be installed */
installPeers: string[];
}
declare type PluginCompatibilityResult =
| PluginCompatibilityResultFailure
| PluginCompatibilityResultSuccess
type PluginCompatibilityResult = PluginCompatibilityResultFailure | PluginCompatibilityResultSuccess;
interface PluginClerkConfig {
/** The keyword that is common among the packages we wish to fetch */
keyword: string
/** The prefix that the names of the packages needed to begin with to be valid to our clerk */
prefix?: string
/** The registry hostname including scheme */
registryHostname: string
/** The keyword that is common among the packages we wish to fetch */
keyword: string;
/** The prefix that the names of the packages needed to begin with to be valid to our clerk */
prefix?: string;
/** The registry hostname including scheme */
registryHostname: string;
}
interface PluginClerkOptions extends Partial<PluginClerkConfig> {
/** Function to send the log messages too */
log?: (logLevel: string, ...args: any[]) => any
/** The amount of milliseconds until we have to query the npm database again, defaults to one day */
cacheDuration?: number
/** Function to send the log messages too */
log?: (logLevel: string, ...args: any[]) => any;
/** The amount of milliseconds until we have to query the npm database again, defaults to one day */
cacheDuration?: number;
}
/** Construct our PluginClerk class, setting the configuration from the options */
export default class PluginClerk {
protected config: PluginClerkConfig
protected log: Function
protected cachely: Cachely<RegistryPackageResults>
protected lastPoll?: number
protected lastUpdate?: number
constructor(opts: PluginClerkOptions)
/** Creates and returns new instance of the current class */
static create(opts: PluginClerkOptions): PluginClerk
/**
* The method that fetches the result from the registry and returns it to the cachely instance
* @returns The fetched packages from the registry that match the keyword
*/
protected requestDatabase({
database,
offset,
}?: {
database?: RegistryPackageResults
offset?: number
}): Promise<RegistryPackageResults>
/** Processes the package data for a plugin name, to return relevant install information, including consideration for dependency compatibility if provided. */
protected getPlugin({
database,
name,
requirements,
dependencies,
}: PluginOptions): PluginCompatibilityResult
/** Get the information for all the plugins in the database, with optional support for compatibility checks */
protected getPlugins({
database,
requirements,
dependencies,
}: PluginsOptions): PluginsResult
/**
* Fetches the database via {@link PluginClerk#fetchDatabase} and then processes the data according to {@link PluginClerk#getPlugin}
* @param opts - forwarded to {@link PluginClerk#getPlugin}, with `database` prefilled
*/
fetchPlugin(opts: FetchPluginOptions): Promise<PluginCompatibilityResult>
/**
* Fetches the database via {@link PluginClerk#fetchDatabase} and then processes the data according to {@link PluginClerk#getPlugins}
* @param opts - forwarded to {@link PluginClerk#getPlugins}, with `database` prefilled
*/
fetchPlugins(opts: FetchPluginsOptions): Promise<PluginsResult>
/** Fetches the unprocessed data for the plugins that were fetched from the registry via the caching layer */
fetchDatabase(): Promise<RegistryPackageResults>
protected config: PluginClerkConfig;
protected log: Function;
protected cachely: Cachely<RegistryPackageResults>;
protected lastPoll?: number;
protected lastUpdate?: number;
constructor(opts: PluginClerkOptions);
/** Creates and returns new instance of the current class */
static create(opts: PluginClerkOptions): PluginClerk;
/**
* The method that fetches the result from the registry and returns it to the cachely instance
* @returns The fetched packages from the registry that match the keyword
*/
protected requestDatabase({ database, offset, }?: {
database?: RegistryPackageResults;
offset?: number;
}): Promise<RegistryPackageResults>;
/** Processes the package data for a plugin name, to return relevant install information, including consideration for dependency compatibility if provided. */
protected getPlugin({ database, name, requirements, dependencies, }: PluginOptions): PluginCompatibilityResult;
/** Get the information for all the plugins in the database, with optional support for compatibility checks */
protected getPlugins({ database, requirements, dependencies, }: PluginsOptions): PluginsResult;
/**
* Fetches the database via {@link PluginClerk#fetchDatabase} and then processes the data according to {@link PluginClerk#getPlugin}
* @param opts - forwarded to {@link PluginClerk#getPlugin}, with `database` prefilled
*/
fetchPlugin(opts: FetchPluginOptions): Promise<PluginCompatibilityResult>;
/**
* Fetches the database via {@link PluginClerk#fetchDatabase} and then processes the data according to {@link PluginClerk#getPlugins}
* @param opts - forwarded to {@link PluginClerk#getPlugins}, with `database` prefilled
*/
fetchPlugins(opts: FetchPluginsOptions): Promise<PluginsResult>;
/** Fetches the unprocessed data for the plugins that were fetched from the registry via the caching layer */
fetchDatabase(): Promise<RegistryPackageResults>;
}
export {}
//# sourceMappingURL=index.d.ts.map
export {};
//# sourceMappingURL=index.d.ts.map

@@ -11,14 +11,92 @@ <!-- LICENSEFILE/ -->

<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
<h2>MIT License</h2>
<h2>The Artistic License 2.0</h2>
<pre>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Copyright (c) 2000-2006, The Perl Foundation.
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Preamble
This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software.
You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement.
Definitions
"Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package.
"Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures.
"You" and "your" means any person who would like to copy, distribute, or modify the Package.
"Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version.
"Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization.
"Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees.
"Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder.
"Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder.
"Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future.
"Source" form means the source code, documentation source, and configuration files for the Package.
"Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form.
Permission for Use and Modification Without Distribution
(1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version.
Permissions for Redistribution of the Standard Version
(2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package.
(3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License.
Distribution of Modified Versions of the Package as Source
(4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following:
(a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version.
(b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version.
(c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under
(i) the Original License or
(ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed.
Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source
(5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version. Such instructions must be valid at the time of your distribution. If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license.
(6) You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version.
Aggregating or Linking the Package
(7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation.
(8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package.
Items That are Not Considered Part of a Modified Version
(9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version. In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license.
General Provisions
(10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
(11) If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
(12) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
(13) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
(14) Disclaimer of Warranty:
THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
<!-- /LICENSEFILE -->
{
"name": "pluginclerk",
"version": "4.13.0",
"version": "5.0.0-next.1698818712.82ef63ef97f6328ab401de038f86d0ded2fefef5",
"description": "A clerk for retrieving compatible plugins from the npm database",
"homepage": "https://github.com/bevry/pluginclerk",
"license": "MIT",
"license": "Artistic-2.0",
"keywords": [
"dependencies",
"esnext",
"es2017",
"export-default",

@@ -23,9 +23,8 @@ "node",

"list": [
"travisci",
"githubworkflow",
"npmversion",
"npmdownloads",
"daviddm",
"daviddmdev",
"---",
"githubsponsors",
"thanksdev",
"patreon",

@@ -41,3 +40,5 @@ "flattr",

"config": {
"githubWorkflow": "bevry",
"githubSponsorsUsername": "balupton",
"thanksdevGithubUsername": "balupton",
"buymeacoffeeUsername": "balupton",

@@ -51,3 +52,2 @@ "cryptoURL": "https://bevry.me/crypto",

"wishlistURL": "https://bevry.me/wishlist",
"travisTLD": "com",
"githubUsername": "bevry",

@@ -75,3 +75,3 @@ "githubRepository": "pluginclerk",

"engines": {
"node": ">=10"
"node": ">=18"
},

@@ -91,4 +91,4 @@ "editions": [

{
"description": "TypeScript compiled against ESNext for Node.js 10 || 12 || 13 || 14 with Require for modules",
"directory": "edition-esnext",
"description": "TypeScript compiled against ES2017 for Node.js with Require for modules",
"directory": "edition-es2017",
"entry": "index.js",

@@ -98,7 +98,7 @@ "tags": [

"javascript",
"esnext",
"es2017",
"require"
],
"engines": {
"node": "10 || 12 || 13 || 14",
"node": "18 || 20 || 21",
"browsers": false

@@ -108,4 +108,4 @@ }

{
"description": "TypeScript compiled against ESNext for Node.js 12 || 13 || 14 with Import for modules",
"directory": "edition-esnext-esm",
"description": "TypeScript compiled against ES2017 for Node.js with Import for modules",
"directory": "edition-es2017-esm",
"entry": "index.js",

@@ -115,7 +115,7 @@ "tags": [

"javascript",
"esnext",
"es2017",
"import"
],
"engines": {
"node": "12 || 13 || 14",
"node": "18 || 20 || 21",
"browsers": false

@@ -127,52 +127,51 @@ }

"type": "module",
"main": "edition-esnext/index.js",
"main": "edition-es2017/index.js",
"exports": {
"node": {
"import": "./edition-esnext-esm/index.js",
"require": "./edition-esnext/index.js"
"import": "./edition-es2017-esm/index.js",
"require": "./edition-es2017/index.js"
}
},
"dependencies": {
"cachely": "^5.18.0",
"cross-fetch": "^3.0.5",
"semver": "^7.3.2"
"cachely": "^5.24.0",
"semver": "^7.5.4"
},
"devDependencies": {
"@bevry/update-contributors": "^1.17.0",
"@typescript-eslint/eslint-plugin": "^4.1.0",
"@typescript-eslint/parser": "^4.1.0",
"assert-helpers": "^7.2.0",
"eslint": "^7.8.1",
"eslint-config-bevry": "^3.22.0",
"eslint-config-prettier": "^6.11.0",
"eslint-plugin-prettier": "^3.1.4",
"kava": "^5.12.0",
"make-deno-edition": "^1.1.1",
"node-fetch": "^2.6.1",
"prettier": "^2.1.1",
"projectz": "^2.16.0",
"surge": "^0.21.6",
"typedoc": "^0.19.1",
"typescript": "^4.0.2",
"valid-directory": "^3.4.0"
"@bevry/update-contributors": "^1.22.0",
"@types/node": "^20.8.10",
"@typescript-eslint/eslint-plugin": "^6.9.1",
"@typescript-eslint/parser": "^6.9.1",
"assert-helpers": "^8.4.0",
"eslint": "^8.52.0",
"eslint-config-bevry": "^3.28.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-prettier": "^5.0.1",
"kava": "^5.15.0",
"make-deno-edition": "^1.3.0",
"prettier": "^3.0.3",
"projectz": "^2.23.0",
"surge": "^0.23.1",
"typedoc": "^0.25.3",
"typescript": "5.2.2",
"valid-directory": "^4.0.0"
},
"scripts": {
"our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
"our:compile": "npm run our:compile:deno && npm run our:compile:edition-esnext && npm run our:compile:edition-esnext-esm && npm run our:compile:types",
"our:compile": "npm run our:compile:deno && npm run our:compile:edition-es2017 && npm run our:compile:edition-es2017-esm && npm run our:compile:types",
"our:compile:deno": "make-deno-edition --attempt",
"our:compile:edition-esnext": "tsc --module commonjs --target ESNext --outDir ./edition-esnext --project tsconfig.json && ( test ! -d edition-esnext/source || ( mv edition-esnext/source edition-temp && rm -Rf edition-esnext && mv edition-temp edition-esnext ) ) && echo '{\"type\": \"commonjs\"}' > edition-esnext/package.json",
"our:compile:edition-esnext-esm": "tsc --module ESNext --target ESNext --outDir ./edition-esnext-esm --project tsconfig.json && ( test ! -d edition-esnext-esm/source || ( mv edition-esnext-esm/source edition-temp && rm -Rf edition-esnext-esm && mv edition-temp edition-esnext-esm ) ) && echo '{\"type\": \"module\"}' > edition-esnext-esm/package.json",
"our:compile:edition-es2017": "tsc --module commonjs --target ES2017 --outDir ./edition-es2017 --project tsconfig.json && ( test ! -d edition-es2017/source || ( mv edition-es2017/source edition-temp && rm -Rf edition-es2017 && mv edition-temp edition-es2017 ) ) && printf '%s' '{\"type\": \"commonjs\"}' > edition-es2017/package.json",
"our:compile:edition-es2017-esm": "tsc --module ESNext --target ES2017 --outDir ./edition-es2017-esm --project tsconfig.json && ( test ! -d edition-es2017-esm/source || ( mv edition-es2017-esm/source edition-temp && rm -Rf edition-es2017-esm && mv edition-temp edition-es2017-esm ) ) && printf '%s' '{\"type\": \"module\"}' > edition-es2017-esm/package.json",
"our:compile:types": "tsc --project tsconfig.json --emitDeclarationOnly --declaration --declarationMap --declarationDir ./compiled-types && ( test ! -d compiled-types/source || ( mv compiled-types/source edition-temp && rm -Rf compiled-types && mv edition-temp compiled-types ) )",
"our:deploy": "echo no need for this project",
"our:deploy": "printf '%s\n' 'no need for this project'",
"our:meta": "npm run our:meta:contributors && npm run our:meta:docs && npm run our:meta:projectz",
"our:meta:contributors": "update-contributors",
"our:meta:docs": "npm run our:meta:docs:typedoc",
"our:meta:docs:typedoc": "rm -Rf ./docs && typedoc --mode file --exclude '**/+(*test*|node_modules)' --excludeExternals --name \"$npm_package_name\" --readme ./README.md --out ./docs ./source",
"our:meta:docs:typedoc": "rm -Rf ./docs && typedoc --exclude '**/+(*test*|node_modules)' --excludeExternals --out ./docs ./source",
"our:meta:projectz": "projectz compile",
"our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",
"our:release:check-changelog": "cat ./HISTORY.md | grep v$npm_package_version || (echo add a changelog entry for v$npm_package_version && exit -1)",
"our:release:check-changelog": "cat ./HISTORY.md | grep \"v$npm_package_version\" || (printf '%s\n' \"add a changelog entry for v$npm_package_version\" && exit -1)",
"our:release:check-dirty": "git diff --exit-code",
"our:release:prepare": "npm run our:clean && npm run our:compile && npm run our:test && npm run our:meta",
"our:release:push": "git push origin master && git push origin --tags",
"our:release:tag": "export MESSAGE=$(cat ./HISTORY.md | sed -n \"/## v$npm_package_version/,/##/p\" | sed 's/## //' | awk 'NR>1{print buf}{buf = $0}') && test \"$MESSAGE\" || (echo 'proper changelog entry not found' && exit -1) && git tag v$npm_package_version -am \"$MESSAGE\"",
"our:release:push": "git push origin && git push origin --tags",
"our:release:tag": "export MESSAGE=$(cat ./HISTORY.md | sed -n \"/## v$npm_package_version/,/##/p\" | sed 's/## //' | awk 'NR>1{print buf}{buf = $0}') && test \"$MESSAGE\" || (printf '%s\n' 'proper changelog entry not found' && exit -1) && git tag \"v$npm_package_version\" -am \"$MESSAGE\"",
"our:setup": "npm run our:setup:install",

@@ -185,3 +184,3 @@ "our:setup:install": "npm install",

"our:verify:prettier": "prettier --write .",
"test": "node ./edition-esnext/test.js"
"test": "node ./edition-es2017/test.js"
},

@@ -188,0 +187,0 @@ "eslintConfig": {

@@ -10,9 +10,8 @@ <!-- TITLE/ -->

<span class="badge-travisci"><a href="http://travis-ci.com/bevry/pluginclerk" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/com/bevry/pluginclerk/master.svg" alt="Travis CI Build Status" /></a></span>
<span class="badge-githubworkflow"><a href="https://github.com/bevry/pluginclerk/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/pluginclerk/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span>
<span class="badge-npmversion"><a href="https://npmjs.org/package/pluginclerk" title="View this project on NPM"><img src="https://img.shields.io/npm/v/pluginclerk.svg" alt="NPM version" /></a></span>
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/pluginclerk" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/pluginclerk.svg" alt="NPM downloads" /></a></span>
<span class="badge-daviddm"><a href="https://david-dm.org/bevry/pluginclerk" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/pluginclerk.svg" alt="Dependency Status" /></a></span>
<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/pluginclerk#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/pluginclerk.svg" alt="Dev Dependency Status" /></a></span>
<br class="badge-separator" />
<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/balupton" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>

@@ -39,3 +38,3 @@ <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>

[Complete API Documentation.](http://master.pluginclerk.bevry.surge.sh/docs/globals.html)
[Complete API Documentation.](http://master.pluginclerk.bevry.surge.sh/docs/)

@@ -166,2 +165,4 @@ ```javascript

Node.js versions 15 and 16 will need to use `--experimental-global-fetch`.
<!-- INSTALL/ -->

@@ -183,5 +184,5 @@

<ul><li><code>pluginclerk/source/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
<li><code>pluginclerk</code> aliases <code>pluginclerk/edition-esnext/index.js</code></li>
<li><code>pluginclerk/edition-esnext/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 10 || 12 || 13 || 14 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
<li><code>pluginclerk/edition-esnext-esm/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#ES.Next" title="ECMAScript Next">ESNext</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 12 || 13 || 14 with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li></ul>
<li><code>pluginclerk</code> aliases <code>pluginclerk/edition-es2017/index.js</code></li>
<li><code>pluginclerk/edition-es2017/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_-_ECMAScript_2017" title="ECMAScript ES2017">ES2017</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
<li><code>pluginclerk/edition-es2017-esm/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_-_ECMAScript_2017" title="ECMAScript ES2017">ES2017</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li></ul>

@@ -224,2 +225,3 @@ <!-- /INSTALL -->

<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/balupton" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>

@@ -255,4 +257,4 @@ <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>

<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
<!-- /LICENSE -->
// Import
import fetch from 'cross-fetch'
import Cachely from 'cachely'

@@ -231,3 +230,3 @@

throw new Error(
'The plugin clerk requires a keyword to be specified, please refer to the API specification'
'The plugin clerk requires a keyword to be specified, please refer to the API specification',
)

@@ -260,5 +259,6 @@ }

offset = 0,
}: { database?: RegistryPackageResults; offset?: number } = {}): Promise<
RegistryPackageResults
> {
}: {
database?: RegistryPackageResults
offset?: number
} = {}): Promise<RegistryPackageResults> {
const me = this

@@ -276,3 +276,3 @@ const nameRegex = /[^a-z0-9]/

me.log('error', 'Fetched data from', url, 'had no objects', data)
return Promise.reject(new Error('Feteched data had no objects'))
return Promise.reject(new Error('Fetched data had no objects'))
}

@@ -287,6 +287,6 @@

const response = await fetch(
`${me.config.registryHostname}/${name}`
`${me.config.registryHostname}/${name}`,
)
pluginData = await response.json()
} catch (err) {
} catch (err: any) {
return Promise.reject(err)

@@ -297,4 +297,4 @@ }

new Error(
'name result from search and from package did not match'
)
'name result from search and from package did not match',
),
)

@@ -308,3 +308,3 @@ }

'warn',
`Plugin ${name} will be ignored as it has an invalid name, must be prefixed with: ${me.config.prefix}`
`Plugin ${name} will be ignored as it has an invalid name, must be prefixed with: ${me.config.prefix}`,
)

@@ -317,8 +317,8 @@ return Promise.resolve()

'info',
`Plugin ${name} was successfully added to the database.`
`Plugin ${name} was successfully added to the database.`,
)
return Promise.resolve()
})
}),
)
} catch (err) {
} catch (err: any) {
me.log('error', 'Fetching database content failed', err)

@@ -328,3 +328,3 @@ return Promise.reject(err)

// this could be optimsied further
// this could be optimized further
// option 1: fetch all the pages first, then combine them, then fetch package data

@@ -338,3 +338,3 @@ // option 2: calculate how many pages are needed, then fetch them all at once (only possible after first page is retrieved, as we need the total)

'info',
'Fetched a portion of the database content, grabbing the rest'
'Fetched a portion of the database content, grabbing the rest',
)

@@ -377,6 +377,8 @@ return this.requestDatabase({ database, offset: subtotal })

const pluginVersionsData = pluginData.versions
const pluginVersionsKeysLatestFirst = Object.keys(
pluginVersionsData
).reverse()
const pluginVersionsKeysLatestFirst =
Object.keys(pluginVersionsData).reverse()
for (const pluginVersion of pluginVersionsKeysLatestFirst) {
// skip pre-release versions
if (pluginVersion.includes('-')) continue
// prepare

@@ -390,3 +392,3 @@ const pluginVersionData = pluginVersionsData[pluginVersion]

requirements,
dependencies
dependencies,
)

@@ -396,3 +398,3 @@ const requiredDependencies = Object.assign(

pluginVersionData.engines || {},
pluginVersionData.peerDependencies || {}
pluginVersionData.peerDependencies || {},
)

@@ -405,3 +407,4 @@

!acceptedRange ||
satisfies(suppliedVersion, acceptedRange) === false
satisfies(suppliedVersion as string, acceptedRange as string) ===
false
) {

@@ -418,7 +421,10 @@ // incompatibility

for (const [name, acceptedRange] of Object.entries(
pluginVersionData.peerDependencies || {}
pluginVersionData.peerDependencies || {},
)) {
const suppliedVersion = existingDependencies[name]
if (suppliedVersion) {
if (satisfies(suppliedVersion, acceptedRange) === false) {
if (
satisfies(suppliedVersion as string, acceptedRange as string) ===
false
) {
// incompatibility

@@ -444,6 +450,6 @@ if (skippedVersions[pluginVersion] == null)

}
} catch (err) {
} catch (err: any) {
this.log('warn', 'The compatibility checks failed with error:', err.stack)
return {
message: 'The compatiblity checks failed',
message: 'The compatibility checks failed',
success: false,

@@ -510,3 +516,3 @@ }

public async fetchPlugin(
opts: FetchPluginOptions
opts: FetchPluginOptions,
): Promise<PluginCompatibilityResult> {

@@ -516,3 +522,3 @@ let database: RegistryPackageResults

database = await this.fetchDatabase()
} catch (err) {
} catch (err: any) {
return Promise.reject(err)

@@ -531,3 +537,3 @@ }

database = await this.fetchDatabase()
} catch (err) {
} catch (err: any) {
return Promise.reject(err)

@@ -534,0 +540,0 @@ }

@@ -9,4 +9,3 @@ {

"strict": true,
"target": "ESNext",
"lib": ["ESNext"],
"target": "ES2017",
"module": "ESNext"

@@ -13,0 +12,0 @@ },

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc