Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@jsenv/url-meta
Advanced tools
Associate data to urls using patterns.
@jsenv/url-meta
allows to associate value to urls using pattern matching.
import { urlToMeta } from "@jsenv/url-meta"
// conditionally associates url and values
const structuredMetaMap = {
color: {
"file:///*": "black",
"file:///*.js": "red",
},
}
const urlToColor = (url) => {
return urlToMeta({ url, structuredMetaMap }).color
}
console.log(`file.json color is ${urlToColor("file:///file.json")}`)
console.log(`file.js color is ${urlToColor("file:///file.js")}`)
Code above logs
file.json color is black
file.js color is red
pattern | Description |
---|---|
**/ | Everything |
*/**/ | Inside a directory |
**/.*/ | Inside directory starting with a dot |
**/node_modules/ | Inside node_modules directory |
**/*.map | Ending with .map |
**/*.test.* | Contains .test. |
* | Inside the root directory only |
*/* | Inside a directory of depth 1 |
Table showing if a pattern matches when applied to "file:///directory/file.js"
pattern | matches? |
---|---|
file:///directory/*.js | true |
file:///directory/**/*.js | true |
file:///**/*.js | true |
file:///directory | false |
file:///directory/ | true |
file:///directory/file.js | true |
file:///directory/file.jsx | false |
metaMap and structuredMetaMap below translates into: "files are visible except thoose in .git/ directory"
const metaMap = {
"**/*": { visible: true },
"**/.git/": { visible: false },
}
const structuredMetaMap = {
visible: {
"**/*/": true,
"**/.git/": false,
},
}
structuredMetaMap allows to group patterns per property which are easier to read and compose. For this reason it's the object structure used by our API.
applyPatternMatching
is a function returning a matchResult
indicating if and how a pattern
matches an url
.
import { applyPatternMatching } from "@jsenv/url-meta"
const matchResult = applyPatternMatching({
pattern: "file:///**/*",
url: "file://Users/directory/file.js",
})
matchResult.matched // true
pattern
parameter is a string looking like an url but where *
and **
can be used so that one specifier can match several url. This parameter is required.
url
parameter is a string representing a url. This parameter is required.
matchResult
represents if and how a pattern
matches an url
.
const fullMatch = applyPatternMatching({
pattern: "file:///**/*",
url: "file://Users/directory/file.js",
})
fullMatch // { matched: true, index: 31, patternIndex: 12 }
fullMatch object indicates pattern
fully matched url
.
const partialMatch = applyPatternMatching({
pattern: "file:///*.js",
url: "file:///file.jsx",
})
partialMatch // { matched: false, index: 14, patternIndex: 14 }
partialMatch object indicates pattern
matched url
until comparing url[14]
with pattern[14]
.
normalizeStructuredMetaMap
is a function resolving a structuredMetaMap
against an url
.
import { normalizeStructuredMetaMap } from "@jsenv/url-meta"
const structuredMetaMapNormalized = normalizeStructuredMetaMap(
{
visible: {
"**/*/": true,
"**/.git/": false,
},
},
"file:///Users/directory/",
)
console.log(JSON.stringify(structuredMetaMapNormalized, null, " "))
{
"visible": {
"file:///Users/directory/**/*/": true,
"file:///Users/directory/**/.git/": false
}
}
urlCanContainsMetaMatching
is a function designed to ignore directory content that would never have specific metas.
import { urlCanContainsMetaMatching } from "@jsenv/url-meta"
const structuredMetaMap = {
color: {
"file:///**/*": "blue",
"file:///**/node_modules/": "green",
},
}
const firstUrlCanHaveFilesWithColorBlue = urlCanContainsMetaMatching({
url: "file:///src/",
specifierMetaMap,
predicate: ({ color }) => color === "blue",
})
firstUrlCanHaveFilesWithColorBlue // true
const secondUrlCanHaveFileWithColorBlue = urlCanContainsMetaMatching({
url: "file:///node_modules/src/",
specifierMetaMap,
predicate: ({ color }) => color === "blue",
})
secondUrlCanHaveFileWithColorBlue // false
urlToMeta
is a function returning an object being the composition of all meta where pattern
matched the url
.
import { urlToMeta } from "@jsenv/url-meta"
const structuredMetaMap = {
insideSrc: {
"file:///src/": true,
},
extensionIsJs: {
"file:///**/*.js": true,
},
}
const urlA = "file:///src/file.js"
const urlB = "file:///src/file.json"
console.log(`${urlA}: ${JSON.stringify(urlToMeta({ url: urlA, specifierMetaMap }), null, " ")}`)
console.log(`${urlB}: ${JSON.stringify(urlToMeta({ url: urlB, specifierMetaMap }), null, " ")}`)
Console output
file:///src/file.js: {
"insideSrc": true,
"extensionIsJs": true,
}
file:///src/file.json: {
"insideSrc": true
}
npm install @jsenv/url-meta
Can be used in browsers and Node.js.
36.0.1
FAQs
Associate value to urls using pattern matching.
The npm package @jsenv/url-meta receives a total of 332 weekly downloads. As such, @jsenv/url-meta popularity was classified as not popular.
We found that @jsenv/url-meta demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.