avancement planning
This commit is contained in:
+17
-3
@@ -144,6 +144,10 @@ Like `normalize` but intended for preparing package.json files for publish.
|
||||
|
||||
---
|
||||
|
||||
### `PackageJson.syncNormalize()`
|
||||
|
||||
This calls normalize synchronously. Most consumers of this package should avoid using this. It was added because some parts of npm were normalizing package content in class constructors and needed this affordance. It will silently ignore any asynchronous steps asked for. Again, this is a compatiblity affordance for some code in npm that is currently impossible to change without a significant semver major change, and is best not used.
|
||||
|
||||
### **static** `async PackageJson.prepare(path, opts = {})`
|
||||
|
||||
Convenience static that calls `load` before calling `prepare`
|
||||
@@ -233,10 +237,20 @@ pkgJson.content
|
||||
|
||||
---
|
||||
|
||||
### `async PackageJson.save()`
|
||||
### `async PackageJson.save([options])`
|
||||
|
||||
Saves the current `content` to the same location used when calling
|
||||
`load()`.
|
||||
|
||||
Saves the current `content` to the same location used when calling `load()`.
|
||||
|
||||
- `options`: `Object` (optional)
|
||||
- `sort`: `Boolean` (optional) — If true, sorts the keys in the resulting `package.json` file for consistency and readability.
|
||||
|
||||
> [!NOTE]
|
||||
> The sort order for `package.json` is based on the conventions from
|
||||
> [sort-package-json](https://github.com/keithamus/sort-package-json/blob/main/defaultRules.md),
|
||||
> cross-checked with the official npm types and documentation:
|
||||
> - https://github.com/npm/types/blob/main/types/index.d.ts#L104
|
||||
> - https://docs.npmjs.com/cli/configuring-npm/package-json
|
||||
|
||||
## LICENSE
|
||||
|
||||
|
||||
+26
-16
@@ -5,7 +5,7 @@ const parseJSON = require('json-parse-even-better-errors')
|
||||
const updateDeps = require('./update-dependencies.js')
|
||||
const updateScripts = require('./update-scripts.js')
|
||||
const updateWorkspaces = require('./update-workspaces.js')
|
||||
const normalize = require('./normalize.js')
|
||||
const { normalize, syncNormalize } = require('./normalize.js')
|
||||
const { read, parse } = require('./read-package.js')
|
||||
const { packageSort } = require('./sort.js')
|
||||
|
||||
@@ -25,6 +25,18 @@ const knownKeys = new Set([
|
||||
])
|
||||
|
||||
class PackageJson {
|
||||
// npm pkg fix
|
||||
static fixSteps = Object.freeze([
|
||||
'binRefs',
|
||||
'bundleDependencies',
|
||||
'fixName',
|
||||
'fixVersionField',
|
||||
'fixRepositoryField',
|
||||
'fixDependencies',
|
||||
'devDependencies',
|
||||
'scriptpath',
|
||||
])
|
||||
|
||||
static normalizeSteps = Object.freeze([
|
||||
'_id',
|
||||
'_attributes',
|
||||
@@ -34,20 +46,7 @@ class PackageJson {
|
||||
'scripts',
|
||||
'funding',
|
||||
'bin',
|
||||
])
|
||||
|
||||
// npm pkg fix
|
||||
static fixSteps = Object.freeze([
|
||||
'binRefs',
|
||||
'bundleDependencies',
|
||||
'bundleDependenciesFalse',
|
||||
'fixName',
|
||||
'fixNameField',
|
||||
'fixVersionField',
|
||||
'fixRepositoryField',
|
||||
'fixDependencies',
|
||||
'devDependencies',
|
||||
'scriptpath',
|
||||
'binDir',
|
||||
])
|
||||
|
||||
static prepareSteps = Object.freeze([
|
||||
@@ -164,7 +163,11 @@ class PackageJson {
|
||||
return this
|
||||
}
|
||||
|
||||
// Manually set data from an existing object
|
||||
fromContent (data) {
|
||||
if (!data || typeof data !== 'object') {
|
||||
throw new Error('Content data must be an object')
|
||||
}
|
||||
this.#manifest = data
|
||||
this.#canSave = false
|
||||
return this
|
||||
@@ -222,7 +225,7 @@ class PackageJson {
|
||||
this.#manifest = step({ content, originalContent: this.content })
|
||||
}
|
||||
|
||||
// unknown properties will just be overwitten
|
||||
// unknown properties will just be overwritten
|
||||
for (const [key, value] of Object.entries(content)) {
|
||||
if (!knownKeys.has(key)) {
|
||||
this.content[key] = value
|
||||
@@ -259,6 +262,13 @@ class PackageJson {
|
||||
}
|
||||
}
|
||||
|
||||
// steps is NOT overrideable here because this is a legacy function that's not being used in new places
|
||||
syncNormalize (opts = {}) {
|
||||
opts.steps = this.constructor.normalizeSteps.filter(s => s !== '_attributes')
|
||||
syncNormalize(this, opts)
|
||||
return this
|
||||
}
|
||||
|
||||
async normalize (opts = {}) {
|
||||
if (!opts.steps) {
|
||||
opts.steps = this.constructor.normalizeSteps
|
||||
|
||||
+6
-9
@@ -1,8 +1,8 @@
|
||||
// Originally normalize-package-data
|
||||
|
||||
const url = require('node:url')
|
||||
const { URL } = require('node:url')
|
||||
const hostedGitInfo = require('hosted-git-info')
|
||||
const validateLicense = require('validate-npm-package-license')
|
||||
const validateLicense = require('./license.js')
|
||||
|
||||
const typos = {
|
||||
dependancies: 'dependencies',
|
||||
@@ -123,8 +123,7 @@ function normalizeData (data, changes) {
|
||||
if (typeof data.bugs === 'string') {
|
||||
if (isEmail(data.bugs)) {
|
||||
data.bugs = { email: data.bugs }
|
||||
/* eslint-disable-next-line node/no-deprecated-api */
|
||||
} else if (url.parse(data.bugs).protocol) {
|
||||
} else if (URL.canParse(data.bugs)) {
|
||||
data.bugs = { url: data.bugs }
|
||||
} else {
|
||||
changes?.push(`Bug string field must be url, email, or {email,url}`)
|
||||
@@ -140,8 +139,7 @@ function normalizeData (data, changes) {
|
||||
const oldBugs = data.bugs
|
||||
data.bugs = {}
|
||||
if (oldBugs.url) {
|
||||
/* eslint-disable-next-line node/no-deprecated-api */
|
||||
if (typeof (oldBugs.url) === 'string' && url.parse(oldBugs.url).protocol) {
|
||||
if (URL.canParse(oldBugs.url)) {
|
||||
data.bugs.url = oldBugs.url
|
||||
} else {
|
||||
changes?.push('bugs.url field must be a string url. Deleted.')
|
||||
@@ -216,8 +214,7 @@ function normalizeData (data, changes) {
|
||||
changes?.push('homepage field must be a string url. Deleted.')
|
||||
delete data.homepage
|
||||
} else {
|
||||
/* eslint-disable-next-line node/no-deprecated-api */
|
||||
if (!url.parse(data.homepage).protocol) {
|
||||
if (!URL.canParse(data.homepage)) {
|
||||
data.homepage = 'http://' + data.homepage
|
||||
}
|
||||
}
|
||||
@@ -233,7 +230,7 @@ function normalizeData (data, changes) {
|
||||
changes?.push('No license field.')
|
||||
} else if (typeof (license) !== 'string' || license.length < 1 || license.trim() === '') {
|
||||
changes?.push('license should be a valid SPDX license expression')
|
||||
} else if (!validateLicense(license).validForNewPackages) {
|
||||
} else if (!validateLicense(license)) {
|
||||
changes?.push('license should be a valid SPDX license expression')
|
||||
}
|
||||
// fixPeople
|
||||
|
||||
+224
-211
@@ -67,7 +67,7 @@ function normalizePackageBin (pkg, changes) {
|
||||
changes?.push(`"bin[${binKey}]" was renamed to "bin[${base}]"`)
|
||||
}
|
||||
if (binTarget !== pkg.bin[binKey]) {
|
||||
changes?.push(`"bin[${base}]" script name was cleaned`)
|
||||
changes?.push(`"bin[${base}]" script name ${binTarget} was invalid and removed`)
|
||||
}
|
||||
pkg.bin[base] = binTarget
|
||||
}
|
||||
@@ -133,15 +133,9 @@ function secureAndUnixifyPath (ref) {
|
||||
return secured.startsWith('./') ? '' : secured
|
||||
}
|
||||
|
||||
// We don't want the `changes` array in here by default because this is a hot
|
||||
// path for parsing packuments during install. So the calling method passes it
|
||||
// in if it wants to track changes.
|
||||
const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase }) => {
|
||||
if (!pkg.content) {
|
||||
throw new Error('Can not normalize without content')
|
||||
}
|
||||
// Only steps that can be ran synchronously. There are some object constructors (i.e. Aborist Node) that need synchronous normalization so here we are.
|
||||
function syncSteps (pkg, { strict, steps, changes, allowLegacyCase }) {
|
||||
const data = pkg.content
|
||||
const scripts = data.scripts || {}
|
||||
const pkgId = `${data.name ?? ''}@${data.version ?? ''}`
|
||||
|
||||
// name and version are load bearing so we have to clean them up first
|
||||
@@ -195,6 +189,7 @@ const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase })
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// remove attributes that start with "_"
|
||||
if (steps.includes('_attributes')) {
|
||||
for (const key in data) {
|
||||
@@ -214,14 +209,14 @@ const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase })
|
||||
}
|
||||
|
||||
// fix bundledDependencies typo
|
||||
// normalize bundleDependencies
|
||||
if (steps.includes('bundledDependencies')) {
|
||||
if (data.bundleDependencies === undefined && data.bundledDependencies !== undefined) {
|
||||
data.bundleDependencies = data.bundledDependencies
|
||||
changes?.push(`Deleted incorrect "bundledDependencies"`)
|
||||
}
|
||||
changes?.push(`Deleted incorrect "bundledDependencies"`)
|
||||
delete data.bundledDependencies
|
||||
}
|
||||
|
||||
// expand "bundleDependencies: true or translate from object"
|
||||
if (steps.includes('bundleDependencies')) {
|
||||
const bd = data.bundleDependencies
|
||||
@@ -260,32 +255,6 @@ const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase })
|
||||
}
|
||||
}
|
||||
|
||||
// add "install" attribute if any "*.gyp" files exist
|
||||
if (steps.includes('gypfile')) {
|
||||
if (!scripts.install && !scripts.preinstall && data.gypfile !== false) {
|
||||
const files = await lazyLoadGlob()('*.gyp', { cwd: pkg.path })
|
||||
if (files.length) {
|
||||
scripts.install = 'node-gyp rebuild'
|
||||
data.scripts = scripts
|
||||
data.gypfile = true
|
||||
changes?.push(`"scripts.install" was set to "node-gyp rebuild"`)
|
||||
changes?.push(`"gypfile" was set to "true"`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// add "start" attribute if "server.js" exists
|
||||
if (steps.includes('serverjs') && !scripts.start) {
|
||||
try {
|
||||
await fs.access(path.join(pkg.path, 'server.js'))
|
||||
scripts.start = 'node server.js'
|
||||
data.scripts = scripts
|
||||
changes?.push('"scripts.start" was set to "node server.js"')
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
|
||||
// strip "node_modules/.bin" from scripts entries
|
||||
// remove invalid scripts entries (non-strings)
|
||||
if ((steps.includes('scripts') || steps.includes('scriptpath')) && data.scripts !== undefined) {
|
||||
@@ -313,179 +282,6 @@ const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase })
|
||||
}
|
||||
}
|
||||
|
||||
// populate "authors" attribute
|
||||
if (steps.includes('authors') && !data.contributors) {
|
||||
try {
|
||||
const authorData = await fs.readFile(path.join(pkg.path, 'AUTHORS'), 'utf8')
|
||||
const authors = authorData.split(/\r?\n/g)
|
||||
.map(line => line.replace(/^\s*#.*$/, '').trim())
|
||||
.filter(line => line)
|
||||
data.contributors = authors
|
||||
changes?.push('"contributors" was auto-populated with the contents of the "AUTHORS" file')
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
|
||||
// populate "readme" attribute
|
||||
if (steps.includes('readme') && !data.readme) {
|
||||
const mdre = /\.m?a?r?k?d?o?w?n?$/i
|
||||
const files = await lazyLoadGlob()('{README,README.*}', {
|
||||
cwd: pkg.path,
|
||||
nocase: true,
|
||||
mark: true,
|
||||
})
|
||||
let readmeFile
|
||||
for (const file of files) {
|
||||
// don't accept directories.
|
||||
if (!file.endsWith(path.sep)) {
|
||||
if (file.match(mdre)) {
|
||||
readmeFile = file
|
||||
break
|
||||
}
|
||||
if (file.endsWith('README')) {
|
||||
readmeFile = file
|
||||
}
|
||||
}
|
||||
}
|
||||
if (readmeFile) {
|
||||
const readmeData = await fs.readFile(path.join(pkg.path, readmeFile), 'utf8')
|
||||
data.readme = readmeData
|
||||
data.readmeFilename = readmeFile
|
||||
changes?.push(`"readme" was set to the contents of ${readmeFile}`)
|
||||
changes?.push(`"readmeFilename" was set to ${readmeFile}`)
|
||||
}
|
||||
if (!data.readme) {
|
||||
data.readme = 'ERROR: No README data found!'
|
||||
}
|
||||
}
|
||||
|
||||
// expand directories.man
|
||||
if (steps.includes('mans')) {
|
||||
if (data.directories?.man && !data.man) {
|
||||
const manDir = secureAndUnixifyPath(data.directories.man)
|
||||
const cwd = path.resolve(pkg.path, manDir)
|
||||
const files = await lazyLoadGlob()('**/*.[0-9]', { cwd })
|
||||
data.man = files.map(man =>
|
||||
path.relative(pkg.path, path.join(cwd, man)).split(path.sep).join('/')
|
||||
)
|
||||
}
|
||||
normalizePackageMan(data, changes)
|
||||
}
|
||||
|
||||
if (steps.includes('bin') || steps.includes('binDir') || steps.includes('binRefs')) {
|
||||
normalizePackageBin(data, changes)
|
||||
}
|
||||
|
||||
// expand "directories.bin"
|
||||
if (steps.includes('binDir') && data.directories?.bin && !data.bin) {
|
||||
const binsDir = path.resolve(pkg.path, secureAndUnixifyPath(data.directories.bin))
|
||||
const bins = await lazyLoadGlob()('**', { cwd: binsDir })
|
||||
data.bin = bins.reduce((acc, binFile) => {
|
||||
if (binFile && !binFile.startsWith('.')) {
|
||||
const binName = path.basename(binFile)
|
||||
acc[binName] = path.join(data.directories.bin, binFile)
|
||||
}
|
||||
return acc
|
||||
}, {})
|
||||
// *sigh*
|
||||
normalizePackageBin(data, changes)
|
||||
}
|
||||
|
||||
// populate "gitHead" attribute
|
||||
if (steps.includes('gitHead') && !data.gitHead) {
|
||||
const git = require('@npmcli/git')
|
||||
const gitRoot = await git.find({ cwd: pkg.path, root })
|
||||
let head
|
||||
if (gitRoot) {
|
||||
try {
|
||||
head = await fs.readFile(path.resolve(gitRoot, '.git/HEAD'), 'utf8')
|
||||
} catch (err) {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
let headData
|
||||
if (head) {
|
||||
if (head.startsWith('ref: ')) {
|
||||
const headRef = head.replace(/^ref: /, '').trim()
|
||||
const headFile = path.resolve(gitRoot, '.git', headRef)
|
||||
try {
|
||||
headData = await fs.readFile(headFile, 'utf8')
|
||||
headData = headData.replace(/^ref: /, '').trim()
|
||||
} catch (err) {
|
||||
// do nothing
|
||||
}
|
||||
if (!headData) {
|
||||
const packFile = path.resolve(gitRoot, '.git/packed-refs')
|
||||
try {
|
||||
let refs = await fs.readFile(packFile, 'utf8')
|
||||
if (refs) {
|
||||
refs = refs.split('\n')
|
||||
for (let i = 0; i < refs.length; i++) {
|
||||
const match = refs[i].match(/^([0-9a-f]{40}) (.+)$/)
|
||||
if (match && match[2].trim() === headRef) {
|
||||
headData = match[1]
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
} else {
|
||||
headData = head.trim()
|
||||
}
|
||||
}
|
||||
if (headData) {
|
||||
data.gitHead = headData
|
||||
}
|
||||
}
|
||||
|
||||
// populate "types" attribute
|
||||
if (steps.includes('fillTypes')) {
|
||||
const index = data.main || 'index.js'
|
||||
|
||||
if (typeof index !== 'string') {
|
||||
throw new TypeError('The "main" attribute must be of type string.')
|
||||
}
|
||||
|
||||
// TODO exports is much more complicated than this in verbose format
|
||||
// We need to support for instance
|
||||
|
||||
// "exports": {
|
||||
// ".": [
|
||||
// {
|
||||
// "default": "./lib/npm.js"
|
||||
// },
|
||||
// "./lib/npm.js"
|
||||
// ],
|
||||
// "./package.json": "./package.json"
|
||||
// },
|
||||
// as well as conditional exports
|
||||
|
||||
// if (data.exports && typeof data.exports === 'string') {
|
||||
// index = data.exports
|
||||
// }
|
||||
|
||||
// if (data.exports && data.exports['.']) {
|
||||
// index = data.exports['.']
|
||||
// if (typeof index !== 'string') {
|
||||
// }
|
||||
// }
|
||||
const extless = path.join(path.dirname(index), path.basename(index, path.extname(index)))
|
||||
const dts = `./${extless}.d.ts`
|
||||
const hasDTSFields = 'types' in data || 'typings' in data
|
||||
if (!hasDTSFields) {
|
||||
try {
|
||||
await fs.access(path.join(pkg.path, dts))
|
||||
data.types = dts.split(path.sep).join('/')
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// "normalizeData" from "read-package-json", which was just a call through to
|
||||
// "normalize-package-data". We only call the "fixer" functions because
|
||||
// outside of that it was also clobbering _id (which we already conditionally
|
||||
@@ -583,6 +379,209 @@ const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase })
|
||||
const { normalizeData } = require('./normalize-data.js')
|
||||
normalizeData(data, changes)
|
||||
}
|
||||
}
|
||||
|
||||
// Steps that require await, distinct from sync-steps.js
|
||||
async function asyncSteps (pkg, { steps, root, changes }) {
|
||||
const data = pkg.content
|
||||
const scripts = data.scripts || {}
|
||||
const pkgId = `${data.name ?? ''}@${data.version ?? ''}`
|
||||
|
||||
// add "install" attribute if any "*.gyp" files exist
|
||||
if (steps.includes('gypfile')) {
|
||||
if (!scripts.install && !scripts.preinstall && data.gypfile !== false) {
|
||||
const files = await lazyLoadGlob()('*.gyp', { cwd: pkg.path })
|
||||
if (files.length) {
|
||||
scripts.install = 'node-gyp rebuild'
|
||||
data.scripts = scripts
|
||||
data.gypfile = true
|
||||
changes?.push(`"scripts.install" was set to "node-gyp rebuild"`)
|
||||
changes?.push(`"gypfile" was set to "true"`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// add "start" attribute if "server.js" exists
|
||||
if (steps.includes('serverjs') && !scripts.start) {
|
||||
try {
|
||||
await fs.access(path.join(pkg.path, 'server.js'))
|
||||
scripts.start = 'node server.js'
|
||||
data.scripts = scripts
|
||||
changes?.push('"scripts.start" was set to "node server.js"')
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
|
||||
// populate "authors" attribute
|
||||
if (steps.includes('authors') && !data.contributors) {
|
||||
try {
|
||||
const authorData = await fs.readFile(path.join(pkg.path, 'AUTHORS'), 'utf8')
|
||||
const authors = authorData.split(/\r?\n/g)
|
||||
.map(line => line.replace(/^\s*#.*$/, '').trim())
|
||||
.filter(line => line)
|
||||
data.contributors = authors
|
||||
changes?.push('"contributors" was auto-populated with the contents of the "AUTHORS" file')
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
|
||||
// populate "readme" attribute
|
||||
if (steps.includes('readme') && !data.readme) {
|
||||
const mdre = /\.m?a?r?k?d?o?w?n?$/i
|
||||
const files = await lazyLoadGlob()('{README,README.*}', {
|
||||
cwd: pkg.path,
|
||||
nocase: true,
|
||||
mark: true,
|
||||
})
|
||||
let readmeFile
|
||||
for (const file of files) {
|
||||
// don't accept directories.
|
||||
if (!file.endsWith(path.sep)) {
|
||||
if (file.match(mdre)) {
|
||||
readmeFile = file
|
||||
break
|
||||
}
|
||||
if (file.endsWith('README')) {
|
||||
readmeFile = file
|
||||
}
|
||||
}
|
||||
}
|
||||
if (readmeFile) {
|
||||
const readmeData = await fs.readFile(path.join(pkg.path, readmeFile), 'utf8')
|
||||
data.readme = readmeData
|
||||
data.readmeFilename = readmeFile
|
||||
changes?.push(`"readme" was set to the contents of ${readmeFile}`)
|
||||
changes?.push(`"readmeFilename" was set to ${readmeFile}`)
|
||||
}
|
||||
if (!data.readme) {
|
||||
data.readme = 'ERROR: No README data found!'
|
||||
}
|
||||
}
|
||||
|
||||
// expand directories.man
|
||||
if (steps.includes('mans')) {
|
||||
if (data.directories?.man && !data.man) {
|
||||
const manDir = secureAndUnixifyPath(data.directories.man)
|
||||
const cwd = path.resolve(pkg.path, manDir)
|
||||
const files = await lazyLoadGlob()('**/*.[0-9]', { cwd })
|
||||
data.man = files.map(man =>
|
||||
path.relative(pkg.path, path.join(cwd, man)).split(path.sep).join('/')
|
||||
)
|
||||
}
|
||||
normalizePackageMan(data, changes)
|
||||
}
|
||||
|
||||
// expand "directories.bin"
|
||||
if (steps.includes('binDir') && data.directories?.bin && !data.bin && pkg.path) {
|
||||
const binPath = secureAndUnixifyPath(data.directories.bin)
|
||||
const bins = await lazyLoadGlob()('**', { cwd: path.resolve(pkg.path, binPath) })
|
||||
data.bin = bins.reduce((acc, binFile) => {
|
||||
if (binFile && !binFile.startsWith('.')) {
|
||||
const binName = path.basename(binFile)
|
||||
// binPath is already cleaned and unixified, no need to path.join here.
|
||||
acc[binName] = `${binPath}/${secureAndUnixifyPath(binFile)}`
|
||||
}
|
||||
return acc
|
||||
}, {})
|
||||
} else if (steps.includes('bin') || steps.includes('binDir') || steps.includes('binRefs')) {
|
||||
normalizePackageBin(data, changes)
|
||||
}
|
||||
|
||||
// populate "gitHead" attribute
|
||||
if (steps.includes('gitHead') && !data.gitHead) {
|
||||
const git = require('@npmcli/git')
|
||||
const gitRoot = await git.find({ cwd: pkg.path, root })
|
||||
let head
|
||||
if (gitRoot) {
|
||||
try {
|
||||
head = await fs.readFile(path.resolve(gitRoot, '.git/HEAD'), 'utf8')
|
||||
} catch (err) {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
let headData
|
||||
if (head) {
|
||||
if (head.startsWith('ref: ')) {
|
||||
const headRef = head.replace(/^ref: /, '').trim()
|
||||
const headFile = path.resolve(gitRoot, '.git', headRef)
|
||||
try {
|
||||
headData = await fs.readFile(headFile, 'utf8')
|
||||
headData = headData.replace(/^ref: /, '').trim()
|
||||
} catch (err) {
|
||||
// do nothing
|
||||
}
|
||||
if (!headData) {
|
||||
const packFile = path.resolve(gitRoot, '.git/packed-refs')
|
||||
try {
|
||||
let refs = await fs.readFile(packFile, 'utf8')
|
||||
if (refs) {
|
||||
refs = refs.split('\n')
|
||||
for (let i = 0; i < refs.length; i++) {
|
||||
const match = refs[i].match(/^([0-9a-f]{40}) (.+)$/)
|
||||
if (match && match[2].trim() === headRef) {
|
||||
headData = match[1]
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
} else {
|
||||
headData = head.trim()
|
||||
}
|
||||
}
|
||||
if (headData) {
|
||||
data.gitHead = headData
|
||||
}
|
||||
}
|
||||
|
||||
// populate "types" attribute
|
||||
if (steps.includes('fillTypes')) {
|
||||
const index = data.main || 'index.js'
|
||||
|
||||
if (typeof index !== 'string') {
|
||||
throw new TypeError('The "main" attribute must be of type string.')
|
||||
}
|
||||
|
||||
// TODO exports is much more complicated than this in verbose format
|
||||
// We need to support for instance
|
||||
|
||||
// "exports": {
|
||||
// ".": [
|
||||
// {
|
||||
// "default": "./lib/npm.js"
|
||||
// },
|
||||
// "./lib/npm.js"
|
||||
// ],
|
||||
// "./package.json": "./package.json"
|
||||
// },
|
||||
// as well as conditional exports
|
||||
|
||||
// if (data.exports && typeof data.exports === 'string') {
|
||||
// index = data.exports
|
||||
// }
|
||||
|
||||
// if (data.exports && data.exports['.']) {
|
||||
// index = data.exports['.']
|
||||
// if (typeof index !== 'string') {
|
||||
// }
|
||||
// }
|
||||
const extless = path.join(path.dirname(index), path.basename(index, path.extname(index)))
|
||||
const dts = `./${extless}.d.ts`
|
||||
const hasDTSFields = 'types' in data || 'typings' in data
|
||||
if (!hasDTSFields) {
|
||||
try {
|
||||
await fs.access(path.join(pkg.path, dts))
|
||||
data.types = dts.split(path.sep).join('/')
|
||||
} catch {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Warn if the bin references don't point to anything. This might be better
|
||||
// in normalize-package-data if it had access to the file path.
|
||||
@@ -598,4 +597,18 @@ const normalize = async (pkg, { strict, steps, root, changes, allowLegacyCase })
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = normalize
|
||||
// We don't want the `changes` array in here by default because this is a hot path for parsing packuments during install. The calling method passes it in if it wants to track changes.
|
||||
async function normalize (pkg, opts) {
|
||||
if (!pkg.content) {
|
||||
throw new Error('Can not normalize without content')
|
||||
}
|
||||
await asyncSteps(pkg, opts)
|
||||
// the normalizeData part of this needs to be the last thing ran, so sync comes second
|
||||
syncSteps(pkg, opts)
|
||||
}
|
||||
|
||||
function syncNormalize (pkg, opts) {
|
||||
syncSteps(pkg, opts)
|
||||
}
|
||||
|
||||
module.exports = { normalize, syncNormalize }
|
||||
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
Copyright (c) 2015, Rebecca Turner
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
||||
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
PERFORMANCE OF THIS SOFTWARE.
|
||||
-138
@@ -1,138 +0,0 @@
|
||||
# hosted-git-info
|
||||
|
||||
This will let you identify and transform various git hosts URLs between
|
||||
protocols. It also can tell you what the URL is for the raw path for
|
||||
particular file for direct access without git.
|
||||
|
||||
## Example
|
||||
|
||||
```javascript
|
||||
const hostedGitInfo = require("hosted-git-info")
|
||||
const info = hostedGitInfo.fromUrl("git@github.com:npm/hosted-git-info.git", opts)
|
||||
/* info looks like:
|
||||
{
|
||||
type: "github",
|
||||
domain: "github.com",
|
||||
user: "npm",
|
||||
project: "hosted-git-info"
|
||||
}
|
||||
*/
|
||||
```
|
||||
|
||||
If the URL can't be matched with a git host, `null` will be returned. We
|
||||
can match git, ssh and https urls. Additionally, we can match ssh connect
|
||||
strings (`git@github.com:npm/hosted-git-info`) and shortcuts (eg,
|
||||
`github:npm/hosted-git-info`). GitHub specifically, is detected in the case
|
||||
of a third, unprefixed, form: `npm/hosted-git-info`.
|
||||
|
||||
If it does match, the returned object has properties of:
|
||||
|
||||
* info.type -- The short name of the service
|
||||
* info.domain -- The domain for git protocol use
|
||||
* info.user -- The name of the user/org on the git host
|
||||
* info.project -- The name of the project on the git host
|
||||
|
||||
## Version Contract
|
||||
|
||||
The major version will be bumped any time…
|
||||
|
||||
* The constructor stops accepting URLs that it previously accepted.
|
||||
* A method is removed.
|
||||
* A method can no longer accept the number and type of arguments it previously accepted.
|
||||
* A method can return a different type than it currently returns.
|
||||
|
||||
Implications:
|
||||
|
||||
* I do not consider the specific format of the urls returned from, say
|
||||
`.https()` to be a part of the contract. The contract is that it will
|
||||
return a string that can be used to fetch the repo via HTTPS. But what
|
||||
that string looks like, specifically, can change.
|
||||
* Dropping support for a hosted git provider would constitute a breaking
|
||||
change.
|
||||
|
||||
## Usage
|
||||
|
||||
### const info = hostedGitInfo.fromUrl(gitSpecifier[, options])
|
||||
|
||||
* *gitSpecifer* is a URL of a git repository or a SCP-style specifier of one.
|
||||
* *options* is an optional object. It can have the following properties:
|
||||
* *noCommittish* — If true then committishes won't be included in generated URLs.
|
||||
* *noGitPlus* — If true then `git+` won't be prefixed on URLs.
|
||||
|
||||
### const infoOrURL = hostedGitInfo.fromManifest(manifest[, options])
|
||||
|
||||
* *manifest* is a package manifest, such as that returned by [`pacote.manifest()`](https://npmjs.com/pacote)
|
||||
* *options* is an optional object. It can have the same properties as `fromUrl` above.
|
||||
|
||||
## Methods
|
||||
|
||||
All of the methods take the same options as the `fromUrl` factory. Options
|
||||
provided to a method override those provided to the constructor.
|
||||
|
||||
* info.file(path, opts)
|
||||
|
||||
Given the path of a file relative to the repository, returns a URL for
|
||||
directly fetching it from the githost. If no committish was set then
|
||||
`HEAD` will be used as the default.
|
||||
|
||||
For example `hostedGitInfo.fromUrl("git@github.com:npm/hosted-git-info.git#v1.0.0").file("package.json")`
|
||||
would return `https://raw.githubusercontent.com/npm/hosted-git-info/v1.0.0/package.json`
|
||||
|
||||
* info.shortcut(opts)
|
||||
|
||||
eg, `github:npm/hosted-git-info`
|
||||
|
||||
* info.browse(path, fragment, opts)
|
||||
|
||||
eg, `https://github.com/npm/hosted-git-info/tree/v1.2.0`,
|
||||
`https://github.com/npm/hosted-git-info/tree/v1.2.0/package.json`,
|
||||
`https://github.com/npm/hosted-git-info/tree/v1.2.0/README.md#supported-hosts`
|
||||
|
||||
* info.bugs(opts)
|
||||
|
||||
eg, `https://github.com/npm/hosted-git-info/issues`
|
||||
|
||||
* info.docs(opts)
|
||||
|
||||
eg, `https://github.com/npm/hosted-git-info/tree/v1.2.0#readme`
|
||||
|
||||
* info.https(opts)
|
||||
|
||||
eg, `git+https://github.com/npm/hosted-git-info.git`
|
||||
|
||||
* info.sshurl(opts)
|
||||
|
||||
eg, `git+ssh://git@github.com/npm/hosted-git-info.git`
|
||||
|
||||
* info.ssh(opts)
|
||||
|
||||
eg, `git@github.com:npm/hosted-git-info.git`
|
||||
|
||||
* info.path(opts)
|
||||
|
||||
eg, `npm/hosted-git-info`
|
||||
|
||||
* info.tarball(opts)
|
||||
|
||||
eg, `https://github.com/npm/hosted-git-info/archive/v1.2.0.tar.gz`
|
||||
|
||||
* info.getDefaultRepresentation()
|
||||
|
||||
Returns the default output type. The default output type is based on the
|
||||
string you passed in to be parsed
|
||||
|
||||
* info.toString(opts)
|
||||
|
||||
Uses the getDefaultRepresentation to call one of the other methods to get a URL for
|
||||
this resource. As such `hostedGitInfo.fromUrl(url).toString()` will give
|
||||
you a normalized version of the URL that still uses the same protocol.
|
||||
|
||||
Shortcuts will still be returned as shortcuts, but the special case github
|
||||
form of `org/project` will be normalized to `github:org/project`.
|
||||
|
||||
SSH connect strings will be normalized into `git+ssh` URLs.
|
||||
|
||||
## Supported hosts
|
||||
|
||||
Currently this supports GitHub (including Gists), Bitbucket, GitLab and Sourcehut.
|
||||
Pull requests for additional hosts welcome.
|
||||
-122
@@ -1,122 +0,0 @@
|
||||
'use strict'
|
||||
|
||||
const parseUrl = require('./parse-url')
|
||||
|
||||
// look for github shorthand inputs, such as npm/cli
|
||||
const isGitHubShorthand = (arg) => {
|
||||
// it cannot contain whitespace before the first #
|
||||
// it cannot start with a / because that's probably an absolute file path
|
||||
// but it must include a slash since repos are username/repository
|
||||
// it cannot start with a . because that's probably a relative file path
|
||||
// it cannot start with an @ because that's a scoped package if it passes the other tests
|
||||
// it cannot contain a : before a # because that tells us that there's a protocol
|
||||
// a second / may not exist before a #
|
||||
const firstHash = arg.indexOf('#')
|
||||
const firstSlash = arg.indexOf('/')
|
||||
const secondSlash = arg.indexOf('/', firstSlash + 1)
|
||||
const firstColon = arg.indexOf(':')
|
||||
const firstSpace = /\s/.exec(arg)
|
||||
const firstAt = arg.indexOf('@')
|
||||
|
||||
const spaceOnlyAfterHash = !firstSpace || (firstHash > -1 && firstSpace.index > firstHash)
|
||||
const atOnlyAfterHash = firstAt === -1 || (firstHash > -1 && firstAt > firstHash)
|
||||
const colonOnlyAfterHash = firstColon === -1 || (firstHash > -1 && firstColon > firstHash)
|
||||
const secondSlashOnlyAfterHash = secondSlash === -1 || (firstHash > -1 && secondSlash > firstHash)
|
||||
const hasSlash = firstSlash > 0
|
||||
// if a # is found, what we really want to know is that the character
|
||||
// immediately before # is not a /
|
||||
const doesNotEndWithSlash = firstHash > -1 ? arg[firstHash - 1] !== '/' : !arg.endsWith('/')
|
||||
const doesNotStartWithDot = !arg.startsWith('.')
|
||||
|
||||
return spaceOnlyAfterHash && hasSlash && doesNotEndWithSlash &&
|
||||
doesNotStartWithDot && atOnlyAfterHash && colonOnlyAfterHash &&
|
||||
secondSlashOnlyAfterHash
|
||||
}
|
||||
|
||||
module.exports = (giturl, opts, { gitHosts, protocols }) => {
|
||||
if (!giturl) {
|
||||
return
|
||||
}
|
||||
|
||||
const correctedUrl = isGitHubShorthand(giturl) ? `github:${giturl}` : giturl
|
||||
const parsed = parseUrl(correctedUrl, protocols)
|
||||
if (!parsed) {
|
||||
return
|
||||
}
|
||||
|
||||
const gitHostShortcut = gitHosts.byShortcut[parsed.protocol]
|
||||
const gitHostDomain = gitHosts.byDomain[parsed.hostname.startsWith('www.')
|
||||
? parsed.hostname.slice(4)
|
||||
: parsed.hostname]
|
||||
const gitHostName = gitHostShortcut || gitHostDomain
|
||||
if (!gitHostName) {
|
||||
return
|
||||
}
|
||||
|
||||
const gitHostInfo = gitHosts[gitHostShortcut || gitHostDomain]
|
||||
let auth = null
|
||||
if (protocols[parsed.protocol]?.auth && (parsed.username || parsed.password)) {
|
||||
auth = `${parsed.username}${parsed.password ? ':' + parsed.password : ''}`
|
||||
}
|
||||
|
||||
let committish = null
|
||||
let user = null
|
||||
let project = null
|
||||
let defaultRepresentation = null
|
||||
|
||||
try {
|
||||
if (gitHostShortcut) {
|
||||
let pathname = parsed.pathname.startsWith('/') ? parsed.pathname.slice(1) : parsed.pathname
|
||||
const firstAt = pathname.indexOf('@')
|
||||
// we ignore auth for shortcuts, so just trim it out
|
||||
if (firstAt > -1) {
|
||||
pathname = pathname.slice(firstAt + 1)
|
||||
}
|
||||
|
||||
const lastSlash = pathname.lastIndexOf('/')
|
||||
if (lastSlash > -1) {
|
||||
user = decodeURIComponent(pathname.slice(0, lastSlash))
|
||||
// we want nulls only, never empty strings
|
||||
if (!user) {
|
||||
user = null
|
||||
}
|
||||
project = decodeURIComponent(pathname.slice(lastSlash + 1))
|
||||
} else {
|
||||
project = decodeURIComponent(pathname)
|
||||
}
|
||||
|
||||
if (project.endsWith('.git')) {
|
||||
project = project.slice(0, -4)
|
||||
}
|
||||
|
||||
if (parsed.hash) {
|
||||
committish = decodeURIComponent(parsed.hash.slice(1))
|
||||
}
|
||||
|
||||
defaultRepresentation = 'shortcut'
|
||||
} else {
|
||||
if (!gitHostInfo.protocols.includes(parsed.protocol)) {
|
||||
return
|
||||
}
|
||||
|
||||
const segments = gitHostInfo.extract(parsed)
|
||||
if (!segments) {
|
||||
return
|
||||
}
|
||||
|
||||
user = segments.user && decodeURIComponent(segments.user)
|
||||
project = decodeURIComponent(segments.project)
|
||||
committish = decodeURIComponent(segments.committish)
|
||||
defaultRepresentation = protocols[parsed.protocol]?.name || parsed.protocol.slice(0, -1)
|
||||
}
|
||||
} catch (err) {
|
||||
/* istanbul ignore else */
|
||||
if (err instanceof URIError) {
|
||||
return
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
}
|
||||
|
||||
return [gitHostName, user, auth, project, committish, defaultRepresentation, opts]
|
||||
}
|
||||
-231
@@ -1,231 +0,0 @@
|
||||
/* eslint-disable max-len */
|
||||
|
||||
'use strict'
|
||||
|
||||
const maybeJoin = (...args) => args.every(arg => arg) ? args.join('') : ''
|
||||
const maybeEncode = (arg) => arg ? encodeURIComponent(arg) : ''
|
||||
const formatHashFragment = (f) => f.toLowerCase()
|
||||
.replace(/^\W+/g, '') // strip leading non-characters
|
||||
.replace(/(?<!\W)\W+$/, '') // strip trailing non-characters
|
||||
.replace(/\//g, '') // strip all slashes
|
||||
.replace(/\W+/g, '-') // replace remaining non-characters with '-'
|
||||
|
||||
const defaults = {
|
||||
sshtemplate: ({ domain, user, project, committish }) =>
|
||||
`git@${domain}:${user}/${project}.git${maybeJoin('#', committish)}`,
|
||||
sshurltemplate: ({ domain, user, project, committish }) =>
|
||||
`git+ssh://git@${domain}/${user}/${project}.git${maybeJoin('#', committish)}`,
|
||||
edittemplate: ({ domain, user, project, committish, editpath, path }) =>
|
||||
`https://${domain}/${user}/${project}${maybeJoin('/', editpath, '/', maybeEncode(committish || 'HEAD'), '/', path)}`,
|
||||
browsetemplate: ({ domain, user, project, committish, treepath }) =>
|
||||
`https://${domain}/${user}/${project}${maybeJoin('/', treepath, '/', maybeEncode(committish))}`,
|
||||
browsetreetemplate: ({ domain, user, project, committish, treepath, path, fragment, hashformat }) =>
|
||||
`https://${domain}/${user}/${project}/${treepath}/${maybeEncode(committish || 'HEAD')}/${path}${maybeJoin('#', hashformat(fragment || ''))}`,
|
||||
browseblobtemplate: ({ domain, user, project, committish, blobpath, path, fragment, hashformat }) =>
|
||||
`https://${domain}/${user}/${project}/${blobpath}/${maybeEncode(committish || 'HEAD')}/${path}${maybeJoin('#', hashformat(fragment || ''))}`,
|
||||
docstemplate: ({ domain, user, project, treepath, committish }) =>
|
||||
`https://${domain}/${user}/${project}${maybeJoin('/', treepath, '/', maybeEncode(committish))}#readme`,
|
||||
httpstemplate: ({ auth, domain, user, project, committish }) =>
|
||||
`git+https://${maybeJoin(auth, '@')}${domain}/${user}/${project}.git${maybeJoin('#', committish)}`,
|
||||
filetemplate: ({ domain, user, project, committish, path }) =>
|
||||
`https://${domain}/${user}/${project}/raw/${maybeEncode(committish || 'HEAD')}/${path}`,
|
||||
shortcuttemplate: ({ type, user, project, committish }) =>
|
||||
`${type}:${user}/${project}${maybeJoin('#', committish)}`,
|
||||
pathtemplate: ({ user, project, committish }) =>
|
||||
`${user}/${project}${maybeJoin('#', committish)}`,
|
||||
bugstemplate: ({ domain, user, project }) =>
|
||||
`https://${domain}/${user}/${project}/issues`,
|
||||
hashformat: formatHashFragment,
|
||||
}
|
||||
|
||||
const hosts = {}
|
||||
hosts.github = {
|
||||
// First two are insecure and generally shouldn't be used any more, but
|
||||
// they are still supported.
|
||||
protocols: ['git:', 'http:', 'git+ssh:', 'git+https:', 'ssh:', 'https:'],
|
||||
domain: 'github.com',
|
||||
treepath: 'tree',
|
||||
blobpath: 'blob',
|
||||
editpath: 'edit',
|
||||
filetemplate: ({ auth, user, project, committish, path }) =>
|
||||
`https://${maybeJoin(auth, '@')}raw.githubusercontent.com/${user}/${project}/${maybeEncode(committish || 'HEAD')}/${path}`,
|
||||
gittemplate: ({ auth, domain, user, project, committish }) =>
|
||||
`git://${maybeJoin(auth, '@')}${domain}/${user}/${project}.git${maybeJoin('#', committish)}`,
|
||||
tarballtemplate: ({ domain, user, project, committish }) =>
|
||||
`https://codeload.${domain}/${user}/${project}/tar.gz/${maybeEncode(committish || 'HEAD')}`,
|
||||
extract: (url) => {
|
||||
let [, user, project, type, committish] = url.pathname.split('/', 5)
|
||||
if (type && type !== 'tree') {
|
||||
return
|
||||
}
|
||||
|
||||
if (!type) {
|
||||
committish = url.hash.slice(1)
|
||||
}
|
||||
|
||||
if (project && project.endsWith('.git')) {
|
||||
project = project.slice(0, -4)
|
||||
}
|
||||
|
||||
if (!user || !project) {
|
||||
return
|
||||
}
|
||||
|
||||
return { user, project, committish }
|
||||
},
|
||||
}
|
||||
|
||||
hosts.bitbucket = {
|
||||
protocols: ['git+ssh:', 'git+https:', 'ssh:', 'https:'],
|
||||
domain: 'bitbucket.org',
|
||||
treepath: 'src',
|
||||
blobpath: 'src',
|
||||
editpath: '?mode=edit',
|
||||
edittemplate: ({ domain, user, project, committish, treepath, path, editpath }) =>
|
||||
`https://${domain}/${user}/${project}${maybeJoin('/', treepath, '/', maybeEncode(committish || 'HEAD'), '/', path, editpath)}`,
|
||||
tarballtemplate: ({ domain, user, project, committish }) =>
|
||||
`https://${domain}/${user}/${project}/get/${maybeEncode(committish || 'HEAD')}.tar.gz`,
|
||||
extract: (url) => {
|
||||
let [, user, project, aux] = url.pathname.split('/', 4)
|
||||
if (['get'].includes(aux)) {
|
||||
return
|
||||
}
|
||||
|
||||
if (project && project.endsWith('.git')) {
|
||||
project = project.slice(0, -4)
|
||||
}
|
||||
|
||||
if (!user || !project) {
|
||||
return
|
||||
}
|
||||
|
||||
return { user, project, committish: url.hash.slice(1) }
|
||||
},
|
||||
}
|
||||
|
||||
hosts.gitlab = {
|
||||
protocols: ['git+ssh:', 'git+https:', 'ssh:', 'https:'],
|
||||
domain: 'gitlab.com',
|
||||
treepath: 'tree',
|
||||
blobpath: 'tree',
|
||||
editpath: '-/edit',
|
||||
httpstemplate: ({ auth, domain, user, project, committish }) =>
|
||||
`git+https://${maybeJoin(auth, '@')}${domain}/${user}/${project}.git${maybeJoin('#', committish)}`,
|
||||
tarballtemplate: ({ domain, user, project, committish }) =>
|
||||
`https://${domain}/${user}/${project}/repository/archive.tar.gz?ref=${maybeEncode(committish || 'HEAD')}`,
|
||||
extract: (url) => {
|
||||
const path = url.pathname.slice(1)
|
||||
if (path.includes('/-/') || path.includes('/archive.tar.gz')) {
|
||||
return
|
||||
}
|
||||
|
||||
const segments = path.split('/')
|
||||
let project = segments.pop()
|
||||
if (project.endsWith('.git')) {
|
||||
project = project.slice(0, -4)
|
||||
}
|
||||
|
||||
const user = segments.join('/')
|
||||
if (!user || !project) {
|
||||
return
|
||||
}
|
||||
|
||||
return { user, project, committish: url.hash.slice(1) }
|
||||
},
|
||||
}
|
||||
|
||||
hosts.gist = {
|
||||
protocols: ['git:', 'git+ssh:', 'git+https:', 'ssh:', 'https:'],
|
||||
domain: 'gist.github.com',
|
||||
editpath: 'edit',
|
||||
sshtemplate: ({ domain, project, committish }) =>
|
||||
`git@${domain}:${project}.git${maybeJoin('#', committish)}`,
|
||||
sshurltemplate: ({ domain, project, committish }) =>
|
||||
`git+ssh://git@${domain}/${project}.git${maybeJoin('#', committish)}`,
|
||||
edittemplate: ({ domain, user, project, committish, editpath }) =>
|
||||
`https://${domain}/${user}/${project}${maybeJoin('/', maybeEncode(committish))}/${editpath}`,
|
||||
browsetemplate: ({ domain, project, committish }) =>
|
||||
`https://${domain}/${project}${maybeJoin('/', maybeEncode(committish))}`,
|
||||
browsetreetemplate: ({ domain, project, committish, path, hashformat }) =>
|
||||
`https://${domain}/${project}${maybeJoin('/', maybeEncode(committish))}${maybeJoin('#', hashformat(path))}`,
|
||||
browseblobtemplate: ({ domain, project, committish, path, hashformat }) =>
|
||||
`https://${domain}/${project}${maybeJoin('/', maybeEncode(committish))}${maybeJoin('#', hashformat(path))}`,
|
||||
docstemplate: ({ domain, project, committish }) =>
|
||||
`https://${domain}/${project}${maybeJoin('/', maybeEncode(committish))}`,
|
||||
httpstemplate: ({ domain, project, committish }) =>
|
||||
`git+https://${domain}/${project}.git${maybeJoin('#', committish)}`,
|
||||
filetemplate: ({ user, project, committish, path }) =>
|
||||
`https://gist.githubusercontent.com/${user}/${project}/raw${maybeJoin('/', maybeEncode(committish))}/${path}`,
|
||||
shortcuttemplate: ({ type, project, committish }) =>
|
||||
`${type}:${project}${maybeJoin('#', committish)}`,
|
||||
pathtemplate: ({ project, committish }) =>
|
||||
`${project}${maybeJoin('#', committish)}`,
|
||||
bugstemplate: ({ domain, project }) =>
|
||||
`https://${domain}/${project}`,
|
||||
gittemplate: ({ domain, project, committish }) =>
|
||||
`git://${domain}/${project}.git${maybeJoin('#', committish)}`,
|
||||
tarballtemplate: ({ project, committish }) =>
|
||||
`https://codeload.github.com/gist/${project}/tar.gz/${maybeEncode(committish || 'HEAD')}`,
|
||||
extract: (url) => {
|
||||
let [, user, project, aux] = url.pathname.split('/', 4)
|
||||
if (aux === 'raw') {
|
||||
return
|
||||
}
|
||||
|
||||
if (!project) {
|
||||
if (!user) {
|
||||
return
|
||||
}
|
||||
|
||||
project = user
|
||||
user = null
|
||||
}
|
||||
|
||||
if (project.endsWith('.git')) {
|
||||
project = project.slice(0, -4)
|
||||
}
|
||||
|
||||
return { user, project, committish: url.hash.slice(1) }
|
||||
},
|
||||
hashformat: function (fragment) {
|
||||
return fragment && 'file-' + formatHashFragment(fragment)
|
||||
},
|
||||
}
|
||||
|
||||
hosts.sourcehut = {
|
||||
protocols: ['git+ssh:', 'https:'],
|
||||
domain: 'git.sr.ht',
|
||||
treepath: 'tree',
|
||||
blobpath: 'tree',
|
||||
filetemplate: ({ domain, user, project, committish, path }) =>
|
||||
`https://${domain}/${user}/${project}/blob/${maybeEncode(committish) || 'HEAD'}/${path}`,
|
||||
httpstemplate: ({ domain, user, project, committish }) =>
|
||||
`https://${domain}/${user}/${project}.git${maybeJoin('#', committish)}`,
|
||||
tarballtemplate: ({ domain, user, project, committish }) =>
|
||||
`https://${domain}/${user}/${project}/archive/${maybeEncode(committish) || 'HEAD'}.tar.gz`,
|
||||
bugstemplate: () => null,
|
||||
extract: (url) => {
|
||||
let [, user, project, aux] = url.pathname.split('/', 4)
|
||||
|
||||
// tarball url
|
||||
if (['archive'].includes(aux)) {
|
||||
return
|
||||
}
|
||||
|
||||
if (project && project.endsWith('.git')) {
|
||||
project = project.slice(0, -4)
|
||||
}
|
||||
|
||||
if (!user || !project) {
|
||||
return
|
||||
}
|
||||
|
||||
return { user, project, committish: url.hash.slice(1) }
|
||||
},
|
||||
}
|
||||
|
||||
for (const [name, host] of Object.entries(hosts)) {
|
||||
hosts[name] = Object.assign({}, defaults, host)
|
||||
}
|
||||
|
||||
module.exports = hosts
|
||||
-227
@@ -1,227 +0,0 @@
|
||||
'use strict'
|
||||
|
||||
const { LRUCache } = require('lru-cache')
|
||||
const hosts = require('./hosts.js')
|
||||
const fromUrl = require('./from-url.js')
|
||||
const parseUrl = require('./parse-url.js')
|
||||
|
||||
const cache = new LRUCache({ max: 1000 })
|
||||
|
||||
function unknownHostedUrl (url) {
|
||||
try {
|
||||
const {
|
||||
protocol,
|
||||
hostname,
|
||||
pathname,
|
||||
} = new URL(url)
|
||||
|
||||
if (!hostname) {
|
||||
return null
|
||||
}
|
||||
|
||||
const proto = /(?:git\+)http:$/.test(protocol) ? 'http:' : 'https:'
|
||||
const path = pathname.replace(/\.git$/, '')
|
||||
return `${proto}//${hostname}${path}`
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
class GitHost {
|
||||
constructor (type, user, auth, project, committish, defaultRepresentation, opts = {}) {
|
||||
Object.assign(this, GitHost.#gitHosts[type], {
|
||||
type,
|
||||
user,
|
||||
auth,
|
||||
project,
|
||||
committish,
|
||||
default: defaultRepresentation,
|
||||
opts,
|
||||
})
|
||||
}
|
||||
|
||||
static #gitHosts = { byShortcut: {}, byDomain: {} }
|
||||
static #protocols = {
|
||||
'git+ssh:': { name: 'sshurl' },
|
||||
'ssh:': { name: 'sshurl' },
|
||||
'git+https:': { name: 'https', auth: true },
|
||||
'git:': { auth: true },
|
||||
'http:': { auth: true },
|
||||
'https:': { auth: true },
|
||||
'git+http:': { auth: true },
|
||||
}
|
||||
|
||||
static addHost (name, host) {
|
||||
GitHost.#gitHosts[name] = host
|
||||
GitHost.#gitHosts.byDomain[host.domain] = name
|
||||
GitHost.#gitHosts.byShortcut[`${name}:`] = name
|
||||
GitHost.#protocols[`${name}:`] = { name }
|
||||
}
|
||||
|
||||
static fromUrl (giturl, opts) {
|
||||
if (typeof giturl !== 'string') {
|
||||
return
|
||||
}
|
||||
|
||||
const key = giturl + JSON.stringify(opts || {})
|
||||
|
||||
if (!cache.has(key)) {
|
||||
const hostArgs = fromUrl(giturl, opts, {
|
||||
gitHosts: GitHost.#gitHosts,
|
||||
protocols: GitHost.#protocols,
|
||||
})
|
||||
cache.set(key, hostArgs ? new GitHost(...hostArgs) : undefined)
|
||||
}
|
||||
|
||||
return cache.get(key)
|
||||
}
|
||||
|
||||
static fromManifest (manifest, opts = {}) {
|
||||
if (!manifest || typeof manifest !== 'object') {
|
||||
return
|
||||
}
|
||||
|
||||
const r = manifest.repository
|
||||
// TODO: look into also checking the `bugs`/`homepage` URLs
|
||||
|
||||
const rurl = r && (
|
||||
typeof r === 'string'
|
||||
? r
|
||||
: typeof r === 'object' && typeof r.url === 'string'
|
||||
? r.url
|
||||
: null
|
||||
)
|
||||
|
||||
if (!rurl) {
|
||||
throw new Error('no repository')
|
||||
}
|
||||
|
||||
const info = (rurl && GitHost.fromUrl(rurl.replace(/^git\+/, ''), opts)) || null
|
||||
if (info) {
|
||||
return info
|
||||
}
|
||||
const unk = unknownHostedUrl(rurl)
|
||||
return GitHost.fromUrl(unk, opts) || unk
|
||||
}
|
||||
|
||||
static parseUrl (url) {
|
||||
return parseUrl(url)
|
||||
}
|
||||
|
||||
#fill (template, opts) {
|
||||
if (typeof template !== 'function') {
|
||||
return null
|
||||
}
|
||||
|
||||
const options = { ...this, ...this.opts, ...opts }
|
||||
|
||||
// the path should always be set so we don't end up with 'undefined' in urls
|
||||
if (!options.path) {
|
||||
options.path = ''
|
||||
}
|
||||
|
||||
// template functions will insert the leading slash themselves
|
||||
if (options.path.startsWith('/')) {
|
||||
options.path = options.path.slice(1)
|
||||
}
|
||||
|
||||
if (options.noCommittish) {
|
||||
options.committish = null
|
||||
}
|
||||
|
||||
const result = template(options)
|
||||
return options.noGitPlus && result.startsWith('git+') ? result.slice(4) : result
|
||||
}
|
||||
|
||||
hash () {
|
||||
return this.committish ? `#${this.committish}` : ''
|
||||
}
|
||||
|
||||
ssh (opts) {
|
||||
return this.#fill(this.sshtemplate, opts)
|
||||
}
|
||||
|
||||
sshurl (opts) {
|
||||
return this.#fill(this.sshurltemplate, opts)
|
||||
}
|
||||
|
||||
browse (path, ...args) {
|
||||
// not a string, treat path as opts
|
||||
if (typeof path !== 'string') {
|
||||
return this.#fill(this.browsetemplate, path)
|
||||
}
|
||||
|
||||
if (typeof args[0] !== 'string') {
|
||||
return this.#fill(this.browsetreetemplate, { ...args[0], path })
|
||||
}
|
||||
|
||||
return this.#fill(this.browsetreetemplate, { ...args[1], fragment: args[0], path })
|
||||
}
|
||||
|
||||
// If the path is known to be a file, then browseFile should be used. For some hosts
|
||||
// the url is the same as browse, but for others like GitHub a file can use both `/tree/`
|
||||
// and `/blob/` in the path. When using a default committish of `HEAD` then the `/tree/`
|
||||
// path will redirect to a specific commit. Using the `/blob/` path avoids this and
|
||||
// does not redirect to a different commit.
|
||||
browseFile (path, ...args) {
|
||||
if (typeof args[0] !== 'string') {
|
||||
return this.#fill(this.browseblobtemplate, { ...args[0], path })
|
||||
}
|
||||
|
||||
return this.#fill(this.browseblobtemplate, { ...args[1], fragment: args[0], path })
|
||||
}
|
||||
|
||||
docs (opts) {
|
||||
return this.#fill(this.docstemplate, opts)
|
||||
}
|
||||
|
||||
bugs (opts) {
|
||||
return this.#fill(this.bugstemplate, opts)
|
||||
}
|
||||
|
||||
https (opts) {
|
||||
return this.#fill(this.httpstemplate, opts)
|
||||
}
|
||||
|
||||
git (opts) {
|
||||
return this.#fill(this.gittemplate, opts)
|
||||
}
|
||||
|
||||
shortcut (opts) {
|
||||
return this.#fill(this.shortcuttemplate, opts)
|
||||
}
|
||||
|
||||
path (opts) {
|
||||
return this.#fill(this.pathtemplate, opts)
|
||||
}
|
||||
|
||||
tarball (opts) {
|
||||
return this.#fill(this.tarballtemplate, { ...opts, noCommittish: false })
|
||||
}
|
||||
|
||||
file (path, opts) {
|
||||
return this.#fill(this.filetemplate, { ...opts, path })
|
||||
}
|
||||
|
||||
edit (path, opts) {
|
||||
return this.#fill(this.edittemplate, { ...opts, path })
|
||||
}
|
||||
|
||||
getDefaultRepresentation () {
|
||||
return this.default
|
||||
}
|
||||
|
||||
toString (opts) {
|
||||
if (this.default && typeof this[this.default] === 'function') {
|
||||
return this[this.default](opts)
|
||||
}
|
||||
|
||||
return this.sshurl(opts)
|
||||
}
|
||||
}
|
||||
|
||||
for (const [name, host] of Object.entries(hosts)) {
|
||||
GitHost.addHost(name, host)
|
||||
}
|
||||
|
||||
module.exports = GitHost
|
||||
-78
@@ -1,78 +0,0 @@
|
||||
const url = require('url')
|
||||
|
||||
const lastIndexOfBefore = (str, char, beforeChar) => {
|
||||
const startPosition = str.indexOf(beforeChar)
|
||||
return str.lastIndexOf(char, startPosition > -1 ? startPosition : Infinity)
|
||||
}
|
||||
|
||||
const safeUrl = (u) => {
|
||||
try {
|
||||
return new url.URL(u)
|
||||
} catch {
|
||||
// this fn should never throw
|
||||
}
|
||||
}
|
||||
|
||||
// accepts input like git:github.com:user/repo and inserts the // after the first :
|
||||
const correctProtocol = (arg, protocols) => {
|
||||
const firstColon = arg.indexOf(':')
|
||||
const proto = arg.slice(0, firstColon + 1)
|
||||
if (Object.prototype.hasOwnProperty.call(protocols, proto)) {
|
||||
return arg
|
||||
}
|
||||
|
||||
const firstAt = arg.indexOf('@')
|
||||
if (firstAt > -1) {
|
||||
if (firstAt > firstColon) {
|
||||
return `git+ssh://${arg}`
|
||||
} else {
|
||||
return arg
|
||||
}
|
||||
}
|
||||
|
||||
const doubleSlash = arg.indexOf('//')
|
||||
if (doubleSlash === firstColon + 1) {
|
||||
return arg
|
||||
}
|
||||
|
||||
return `${arg.slice(0, firstColon + 1)}//${arg.slice(firstColon + 1)}`
|
||||
}
|
||||
|
||||
// attempt to correct an scp style url so that it will parse with `new URL()`
|
||||
const correctUrl = (giturl) => {
|
||||
// ignore @ that come after the first hash since the denotes the start
|
||||
// of a committish which can contain @ characters
|
||||
const firstAt = lastIndexOfBefore(giturl, '@', '#')
|
||||
// ignore colons that come after the hash since that could include colons such as:
|
||||
// git@github.com:user/package-2#semver:^1.0.0
|
||||
const lastColonBeforeHash = lastIndexOfBefore(giturl, ':', '#')
|
||||
|
||||
if (lastColonBeforeHash > firstAt) {
|
||||
// the last : comes after the first @ (or there is no @)
|
||||
// like it would in:
|
||||
// proto://hostname.com:user/repo
|
||||
// username@hostname.com:user/repo
|
||||
// :password@hostname.com:user/repo
|
||||
// username:password@hostname.com:user/repo
|
||||
// proto://username@hostname.com:user/repo
|
||||
// proto://:password@hostname.com:user/repo
|
||||
// proto://username:password@hostname.com:user/repo
|
||||
// then we replace the last : with a / to create a valid path
|
||||
giturl = giturl.slice(0, lastColonBeforeHash) + '/' + giturl.slice(lastColonBeforeHash + 1)
|
||||
}
|
||||
|
||||
if (lastIndexOfBefore(giturl, ':', '#') === -1 && giturl.indexOf('//') === -1) {
|
||||
// we have no : at all
|
||||
// as it would be in:
|
||||
// username@hostname.com/user/repo
|
||||
// then we prepend a protocol
|
||||
giturl = `git+ssh://${giturl}`
|
||||
}
|
||||
|
||||
return giturl
|
||||
}
|
||||
|
||||
module.exports = (giturl, protocols) => {
|
||||
const withProtocol = protocols ? correctProtocol(giturl, protocols) : giturl
|
||||
return safeUrl(withProtocol) || safeUrl(correctUrl(withProtocol))
|
||||
}
|
||||
-61
@@ -1,61 +0,0 @@
|
||||
{
|
||||
"name": "hosted-git-info",
|
||||
"version": "8.1.0",
|
||||
"description": "Provides metadata and conversions from repository urls for GitHub, Bitbucket and GitLab",
|
||||
"main": "./lib/index.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/npm/hosted-git-info.git"
|
||||
},
|
||||
"keywords": [
|
||||
"git",
|
||||
"github",
|
||||
"bitbucket",
|
||||
"gitlab"
|
||||
],
|
||||
"author": "GitHub Inc.",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://github.com/npm/hosted-git-info/issues"
|
||||
},
|
||||
"homepage": "https://github.com/npm/hosted-git-info",
|
||||
"scripts": {
|
||||
"posttest": "npm run lint",
|
||||
"snap": "tap",
|
||||
"test": "tap",
|
||||
"test:coverage": "tap --coverage-report=html",
|
||||
"lint": "npm run eslint",
|
||||
"postlint": "template-oss-check",
|
||||
"lintfix": "npm run eslint -- --fix",
|
||||
"template-oss-apply": "template-oss-apply --force",
|
||||
"eslint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\""
|
||||
},
|
||||
"dependencies": {
|
||||
"lru-cache": "^10.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@npmcli/eslint-config": "^5.0.0",
|
||||
"@npmcli/template-oss": "4.24.3",
|
||||
"tap": "^16.0.1"
|
||||
},
|
||||
"files": [
|
||||
"bin/",
|
||||
"lib/"
|
||||
],
|
||||
"engines": {
|
||||
"node": "^18.17.0 || >=20.5.0"
|
||||
},
|
||||
"tap": {
|
||||
"color": 1,
|
||||
"coverage": true,
|
||||
"nyc-arg": [
|
||||
"--exclude",
|
||||
"tap-snapshots/**"
|
||||
]
|
||||
},
|
||||
"templateOSS": {
|
||||
"//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
|
||||
"version": "4.24.3",
|
||||
"publish": "true"
|
||||
}
|
||||
}
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
The ISC License
|
||||
|
||||
Copyright (c) 2010-2023 Isaac Z. Schlueter and Contributors
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
-331
@@ -1,331 +0,0 @@
|
||||
# lru-cache
|
||||
|
||||
A cache object that deletes the least-recently-used items.
|
||||
|
||||
Specify a max number of the most recently used items that you
|
||||
want to keep, and this cache will keep that many of the most
|
||||
recently accessed items.
|
||||
|
||||
This is not primarily a TTL cache, and does not make strong TTL
|
||||
guarantees. There is no preemptive pruning of expired items by
|
||||
default, but you _may_ set a TTL on the cache or on a single
|
||||
`set`. If you do so, it will treat expired items as missing, and
|
||||
delete them when fetched. If you are more interested in TTL
|
||||
caching than LRU caching, check out
|
||||
[@isaacs/ttlcache](http://npm.im/@isaacs/ttlcache).
|
||||
|
||||
As of version 7, this is one of the most performant LRU
|
||||
implementations available in JavaScript, and supports a wide
|
||||
diversity of use cases. However, note that using some of the
|
||||
features will necessarily impact performance, by causing the
|
||||
cache to have to do more work. See the "Performance" section
|
||||
below.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install lru-cache --save
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
// hybrid module, either works
|
||||
import { LRUCache } from 'lru-cache'
|
||||
// or:
|
||||
const { LRUCache } = require('lru-cache')
|
||||
// or in minified form for web browsers:
|
||||
import { LRUCache } from 'http://unpkg.com/lru-cache@9/dist/mjs/index.min.mjs'
|
||||
|
||||
// At least one of 'max', 'ttl', or 'maxSize' is required, to prevent
|
||||
// unsafe unbounded storage.
|
||||
//
|
||||
// In most cases, it's best to specify a max for performance, so all
|
||||
// the required memory allocation is done up-front.
|
||||
//
|
||||
// All the other options are optional, see the sections below for
|
||||
// documentation on what each one does. Most of them can be
|
||||
// overridden for specific items in get()/set()
|
||||
const options = {
|
||||
max: 500,
|
||||
|
||||
// for use with tracking overall storage size
|
||||
maxSize: 5000,
|
||||
sizeCalculation: (value, key) => {
|
||||
return 1
|
||||
},
|
||||
|
||||
// for use when you need to clean up something when objects
|
||||
// are evicted from the cache
|
||||
dispose: (value, key) => {
|
||||
freeFromMemoryOrWhatever(value)
|
||||
},
|
||||
|
||||
// how long to live in ms
|
||||
ttl: 1000 * 60 * 5,
|
||||
|
||||
// return stale items before removing from cache?
|
||||
allowStale: false,
|
||||
|
||||
updateAgeOnGet: false,
|
||||
updateAgeOnHas: false,
|
||||
|
||||
// async method to use for cache.fetch(), for
|
||||
// stale-while-revalidate type of behavior
|
||||
fetchMethod: async (
|
||||
key,
|
||||
staleValue,
|
||||
{ options, signal, context }
|
||||
) => {},
|
||||
}
|
||||
|
||||
const cache = new LRUCache(options)
|
||||
|
||||
cache.set('key', 'value')
|
||||
cache.get('key') // "value"
|
||||
|
||||
// non-string keys ARE fully supported
|
||||
// but note that it must be THE SAME object, not
|
||||
// just a JSON-equivalent object.
|
||||
var someObject = { a: 1 }
|
||||
cache.set(someObject, 'a value')
|
||||
// Object keys are not toString()-ed
|
||||
cache.set('[object Object]', 'a different value')
|
||||
assert.equal(cache.get(someObject), 'a value')
|
||||
// A similar object with same keys/values won't work,
|
||||
// because it's a different object identity
|
||||
assert.equal(cache.get({ a: 1 }), undefined)
|
||||
|
||||
cache.clear() // empty the cache
|
||||
```
|
||||
|
||||
If you put more stuff in the cache, then less recently used items
|
||||
will fall out. That's what an LRU cache is.
|
||||
|
||||
For full description of the API and all options, please see [the
|
||||
LRUCache typedocs](https://isaacs.github.io/node-lru-cache/)
|
||||
|
||||
## Storage Bounds Safety
|
||||
|
||||
This implementation aims to be as flexible as possible, within
|
||||
the limits of safe memory consumption and optimal performance.
|
||||
|
||||
At initial object creation, storage is allocated for `max` items.
|
||||
If `max` is set to zero, then some performance is lost, and item
|
||||
count is unbounded. Either `maxSize` or `ttl` _must_ be set if
|
||||
`max` is not specified.
|
||||
|
||||
If `maxSize` is set, then this creates a safe limit on the
|
||||
maximum storage consumed, but without the performance benefits of
|
||||
pre-allocation. When `maxSize` is set, every item _must_ provide
|
||||
a size, either via the `sizeCalculation` method provided to the
|
||||
constructor, or via a `size` or `sizeCalculation` option provided
|
||||
to `cache.set()`. The size of every item _must_ be a positive
|
||||
integer.
|
||||
|
||||
If neither `max` nor `maxSize` are set, then `ttl` tracking must
|
||||
be enabled. Note that, even when tracking item `ttl`, items are
|
||||
_not_ preemptively deleted when they become stale, unless
|
||||
`ttlAutopurge` is enabled. Instead, they are only purged the
|
||||
next time the key is requested. Thus, if `ttlAutopurge`, `max`,
|
||||
and `maxSize` are all not set, then the cache will potentially
|
||||
grow unbounded.
|
||||
|
||||
In this case, a warning is printed to standard error. Future
|
||||
versions may require the use of `ttlAutopurge` if `max` and
|
||||
`maxSize` are not specified.
|
||||
|
||||
If you truly wish to use a cache that is bound _only_ by TTL
|
||||
expiration, consider using a `Map` object, and calling
|
||||
`setTimeout` to delete entries when they expire. It will perform
|
||||
much better than an LRU cache.
|
||||
|
||||
Here is an implementation you may use, under the same
|
||||
[license](./LICENSE) as this package:
|
||||
|
||||
```js
|
||||
// a storage-unbounded ttl cache that is not an lru-cache
|
||||
const cache = {
|
||||
data: new Map(),
|
||||
timers: new Map(),
|
||||
set: (k, v, ttl) => {
|
||||
if (cache.timers.has(k)) {
|
||||
clearTimeout(cache.timers.get(k))
|
||||
}
|
||||
cache.timers.set(
|
||||
k,
|
||||
setTimeout(() => cache.delete(k), ttl)
|
||||
)
|
||||
cache.data.set(k, v)
|
||||
},
|
||||
get: k => cache.data.get(k),
|
||||
has: k => cache.data.has(k),
|
||||
delete: k => {
|
||||
if (cache.timers.has(k)) {
|
||||
clearTimeout(cache.timers.get(k))
|
||||
}
|
||||
cache.timers.delete(k)
|
||||
return cache.data.delete(k)
|
||||
},
|
||||
clear: () => {
|
||||
cache.data.clear()
|
||||
for (const v of cache.timers.values()) {
|
||||
clearTimeout(v)
|
||||
}
|
||||
cache.timers.clear()
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
If that isn't to your liking, check out
|
||||
[@isaacs/ttlcache](http://npm.im/@isaacs/ttlcache).
|
||||
|
||||
## Storing Undefined Values
|
||||
|
||||
This cache never stores undefined values, as `undefined` is used
|
||||
internally in a few places to indicate that a key is not in the
|
||||
cache.
|
||||
|
||||
You may call `cache.set(key, undefined)`, but this is just
|
||||
an alias for `cache.delete(key)`. Note that this has the effect
|
||||
that `cache.has(key)` will return _false_ after setting it to
|
||||
undefined.
|
||||
|
||||
```js
|
||||
cache.set(myKey, undefined)
|
||||
cache.has(myKey) // false!
|
||||
```
|
||||
|
||||
If you need to track `undefined` values, and still note that the
|
||||
key is in the cache, an easy workaround is to use a sigil object
|
||||
of your own.
|
||||
|
||||
```js
|
||||
import { LRUCache } from 'lru-cache'
|
||||
const undefinedValue = Symbol('undefined')
|
||||
const cache = new LRUCache(...)
|
||||
const mySet = (key, value) =>
|
||||
cache.set(key, value === undefined ? undefinedValue : value)
|
||||
const myGet = (key, value) => {
|
||||
const v = cache.get(key)
|
||||
return v === undefinedValue ? undefined : v
|
||||
}
|
||||
```
|
||||
|
||||
## Performance
|
||||
|
||||
As of January 2022, version 7 of this library is one of the most
|
||||
performant LRU cache implementations in JavaScript.
|
||||
|
||||
Benchmarks can be extremely difficult to get right. In
|
||||
particular, the performance of set/get/delete operations on
|
||||
objects will vary _wildly_ depending on the type of key used. V8
|
||||
is highly optimized for objects with keys that are short strings,
|
||||
especially integer numeric strings. Thus any benchmark which
|
||||
tests _solely_ using numbers as keys will tend to find that an
|
||||
object-based approach performs the best.
|
||||
|
||||
Note that coercing _anything_ to strings to use as object keys is
|
||||
unsafe, unless you can be 100% certain that no other type of
|
||||
value will be used. For example:
|
||||
|
||||
```js
|
||||
const myCache = {}
|
||||
const set = (k, v) => (myCache[k] = v)
|
||||
const get = k => myCache[k]
|
||||
|
||||
set({}, 'please hang onto this for me')
|
||||
set('[object Object]', 'oopsie')
|
||||
```
|
||||
|
||||
Also beware of "Just So" stories regarding performance. Garbage
|
||||
collection of large (especially: deep) object graphs can be
|
||||
incredibly costly, with several "tipping points" where it
|
||||
increases exponentially. As a result, putting that off until
|
||||
later can make it much worse, and less predictable. If a library
|
||||
performs well, but only in a scenario where the object graph is
|
||||
kept shallow, then that won't help you if you are using large
|
||||
objects as keys.
|
||||
|
||||
In general, when attempting to use a library to improve
|
||||
performance (such as a cache like this one), it's best to choose
|
||||
an option that will perform well in the sorts of scenarios where
|
||||
you'll actually use it.
|
||||
|
||||
This library is optimized for repeated gets and minimizing
|
||||
eviction time, since that is the expected need of a LRU. Set
|
||||
operations are somewhat slower on average than a few other
|
||||
options, in part because of that optimization. It is assumed
|
||||
that you'll be caching some costly operation, ideally as rarely
|
||||
as possible, so optimizing set over get would be unwise.
|
||||
|
||||
If performance matters to you:
|
||||
|
||||
1. If it's at all possible to use small integer values as keys,
|
||||
and you can guarantee that no other types of values will be
|
||||
used as keys, then do that, and use a cache such as
|
||||
[lru-fast](https://npmjs.com/package/lru-fast), or
|
||||
[mnemonist's
|
||||
LRUCache](https://yomguithereal.github.io/mnemonist/lru-cache)
|
||||
which uses an Object as its data store.
|
||||
|
||||
2. Failing that, if at all possible, use short non-numeric
|
||||
strings (ie, less than 256 characters) as your keys, and use
|
||||
[mnemonist's
|
||||
LRUCache](https://yomguithereal.github.io/mnemonist/lru-cache).
|
||||
|
||||
3. If the types of your keys will be anything else, especially
|
||||
long strings, strings that look like floats, objects, or some
|
||||
mix of types, or if you aren't sure, then this library will
|
||||
work well for you.
|
||||
|
||||
If you do not need the features that this library provides
|
||||
(like asynchronous fetching, a variety of TTL staleness
|
||||
options, and so on), then [mnemonist's
|
||||
LRUMap](https://yomguithereal.github.io/mnemonist/lru-map) is
|
||||
a very good option, and just slightly faster than this module
|
||||
(since it does considerably less).
|
||||
|
||||
4. Do not use a `dispose` function, size tracking, or especially
|
||||
ttl behavior, unless absolutely needed. These features are
|
||||
convenient, and necessary in some use cases, and every attempt
|
||||
has been made to make the performance impact minimal, but it
|
||||
isn't nothing.
|
||||
|
||||
## Breaking Changes in Version 7
|
||||
|
||||
This library changed to a different algorithm and internal data
|
||||
structure in version 7, yielding significantly better
|
||||
performance, albeit with some subtle changes as a result.
|
||||
|
||||
If you were relying on the internals of LRUCache in version 6 or
|
||||
before, it probably will not work in version 7 and above.
|
||||
|
||||
## Breaking Changes in Version 8
|
||||
|
||||
- The `fetchContext` option was renamed to `context`, and may no
|
||||
longer be set on the cache instance itself.
|
||||
- Rewritten in TypeScript, so pretty much all the types moved
|
||||
around a lot.
|
||||
- The AbortController/AbortSignal polyfill was removed. For this
|
||||
reason, **Node version 16.14.0 or higher is now required**.
|
||||
- Internal properties were moved to actual private class
|
||||
properties.
|
||||
- Keys and values must not be `null` or `undefined`.
|
||||
- Minified export available at `'lru-cache/min'`, for both CJS
|
||||
and MJS builds.
|
||||
|
||||
## Breaking Changes in Version 9
|
||||
|
||||
- Named export only, no default export.
|
||||
- AbortController polyfill returned, albeit with a warning when
|
||||
used.
|
||||
|
||||
## Breaking Changes in Version 10
|
||||
|
||||
- `cache.fetch()` return type is now `Promise<V | undefined>`
|
||||
instead of `Promise<V | void>`. This is an irrelevant change
|
||||
practically speaking, but can require changes for TypeScript
|
||||
users.
|
||||
|
||||
For more info, see the [change log](CHANGELOG.md).
|
||||
Generated
Vendored
-1277
File diff suppressed because it is too large
Load Diff
Generated
Vendored
-1
File diff suppressed because one or more lines are too long
-1546
File diff suppressed because it is too large
Load Diff
Generated
Vendored
-1
File diff suppressed because one or more lines are too long
Generated
Vendored
-2
File diff suppressed because one or more lines are too long
Generated
Vendored
-7
File diff suppressed because one or more lines are too long
Generated
Vendored
-3
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"type": "commonjs"
|
||||
}
|
||||
-1277
File diff suppressed because it is too large
Load Diff
-1
File diff suppressed because one or more lines are too long
-1542
File diff suppressed because it is too large
Load Diff
-1
File diff suppressed because one or more lines are too long
-2
File diff suppressed because one or more lines are too long
Generated
Vendored
-7
File diff suppressed because one or more lines are too long
-3
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"type": "module"
|
||||
}
|
||||
-116
@@ -1,116 +0,0 @@
|
||||
{
|
||||
"name": "lru-cache",
|
||||
"publishConfig": {
|
||||
"tag": "legacy-v10"
|
||||
},
|
||||
"description": "A cache object that deletes the least-recently-used items.",
|
||||
"version": "10.4.3",
|
||||
"author": "Isaac Z. Schlueter <i@izs.me>",
|
||||
"keywords": [
|
||||
"mru",
|
||||
"lru",
|
||||
"cache"
|
||||
],
|
||||
"sideEffects": false,
|
||||
"scripts": {
|
||||
"build": "npm run prepare",
|
||||
"prepare": "tshy && bash fixup.sh",
|
||||
"pretest": "npm run prepare",
|
||||
"presnap": "npm run prepare",
|
||||
"test": "tap",
|
||||
"snap": "tap",
|
||||
"preversion": "npm test",
|
||||
"postversion": "npm publish",
|
||||
"prepublishOnly": "git push origin --follow-tags",
|
||||
"format": "prettier --write .",
|
||||
"typedoc": "typedoc --tsconfig ./.tshy/esm.json ./src/*.ts",
|
||||
"benchmark-results-typedoc": "bash scripts/benchmark-results-typedoc.sh",
|
||||
"prebenchmark": "npm run prepare",
|
||||
"benchmark": "make -C benchmark",
|
||||
"preprofile": "npm run prepare",
|
||||
"profile": "make -C benchmark profile"
|
||||
},
|
||||
"main": "./dist/commonjs/index.js",
|
||||
"types": "./dist/commonjs/index.d.ts",
|
||||
"tshy": {
|
||||
"exports": {
|
||||
".": "./src/index.ts",
|
||||
"./min": {
|
||||
"import": {
|
||||
"types": "./dist/esm/index.d.ts",
|
||||
"default": "./dist/esm/index.min.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./dist/commonjs/index.d.ts",
|
||||
"default": "./dist/commonjs/index.min.js"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/isaacs/node-lru-cache.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.2.5",
|
||||
"@types/tap": "^15.0.6",
|
||||
"benchmark": "^2.1.4",
|
||||
"esbuild": "^0.17.11",
|
||||
"eslint-config-prettier": "^8.5.0",
|
||||
"marked": "^4.2.12",
|
||||
"mkdirp": "^2.1.5",
|
||||
"prettier": "^2.6.2",
|
||||
"tap": "^20.0.3",
|
||||
"tshy": "^2.0.0",
|
||||
"tslib": "^2.4.0",
|
||||
"typedoc": "^0.25.3",
|
||||
"typescript": "^5.2.2"
|
||||
},
|
||||
"license": "ISC",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"prettier": {
|
||||
"semi": false,
|
||||
"printWidth": 70,
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"singleQuote": true,
|
||||
"jsxSingleQuote": false,
|
||||
"bracketSameLine": true,
|
||||
"arrowParens": "avoid",
|
||||
"endOfLine": "lf"
|
||||
},
|
||||
"tap": {
|
||||
"node-arg": [
|
||||
"--expose-gc"
|
||||
],
|
||||
"plugin": [
|
||||
"@tapjs/clock"
|
||||
]
|
||||
},
|
||||
"exports": {
|
||||
".": {
|
||||
"import": {
|
||||
"types": "./dist/esm/index.d.ts",
|
||||
"default": "./dist/esm/index.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./dist/commonjs/index.d.ts",
|
||||
"default": "./dist/commonjs/index.js"
|
||||
}
|
||||
},
|
||||
"./min": {
|
||||
"import": {
|
||||
"types": "./dist/esm/index.d.ts",
|
||||
"default": "./dist/esm/index.min.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./dist/commonjs/index.d.ts",
|
||||
"default": "./dist/commonjs/index.min.js"
|
||||
}
|
||||
}
|
||||
},
|
||||
"type": "module",
|
||||
"module": "./dist/esm/index.js"
|
||||
}
|
||||
+11
-13
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@npmcli/package-json",
|
||||
"version": "6.2.0",
|
||||
"version": "7.0.5",
|
||||
"description": "Programmatic API to update package.json",
|
||||
"keywords": [
|
||||
"npm",
|
||||
@@ -29,27 +29,25 @@
|
||||
"eslint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\""
|
||||
},
|
||||
"dependencies": {
|
||||
"@npmcli/git": "^6.0.0",
|
||||
"glob": "^10.2.2",
|
||||
"hosted-git-info": "^8.0.0",
|
||||
"json-parse-even-better-errors": "^4.0.0",
|
||||
"proc-log": "^5.0.0",
|
||||
"@npmcli/git": "^7.0.0",
|
||||
"glob": "^13.0.0",
|
||||
"hosted-git-info": "^9.0.0",
|
||||
"json-parse-even-better-errors": "^5.0.0",
|
||||
"proc-log": "^6.0.0",
|
||||
"semver": "^7.5.3",
|
||||
"validate-npm-package-license": "^3.0.4"
|
||||
"spdx-expression-parse": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@npmcli/eslint-config": "^5.1.0",
|
||||
"@npmcli/template-oss": "4.23.6",
|
||||
"read-package-json": "^7.0.0",
|
||||
"read-package-json-fast": "^4.0.0",
|
||||
"@npmcli/eslint-config": "^6.0.0",
|
||||
"@npmcli/template-oss": "4.28.1",
|
||||
"tap": "^16.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": "^18.17.0 || >=20.5.0"
|
||||
"node": "^20.17.0 || >=22.9.0"
|
||||
},
|
||||
"templateOSS": {
|
||||
"//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
|
||||
"version": "4.23.6",
|
||||
"version": "4.28.1",
|
||||
"publish": "true"
|
||||
},
|
||||
"tap": {
|
||||
|
||||
Reference in New Issue
Block a user