Skip to content

docs: add backticks around code snippets in descriptions #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
43081j merged 1 commit into from
Mar 25, 2026
Merged

docs: add backticks around code snippets in descriptions #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions manifests/micro-utilities.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"snippet::array-coerce": {
"id": "snippet::array-coerce",
"type": "simple",
"description": "You can use a combination of a ternary operator and Array.isArray to make sure a value, undefined, null or an array is always returned as an array.",
"description": "You can use a combination of a ternary operator and `Array.isArray` to make sure a value, `undefined`, `null` or an array is always returned as an array.",
"example": "(arr == null ? [] : Array.isArray(arr) ? arr : [arr])"
},
"snippet::array-difference": {
"id": "snippet::array-difference",
"type": "simple",
"description": "You can use a combination of filter and includes to calculate the difference between two arrays.",
"description": "You can use a combination of `filter` and `includes` to calculate the difference between two arrays.",
"example": "const difference = (a, b) => a.filter((item) => !b.includes(item))"
},
"snippet::array-from-count": {
Expand All @@ -33,13 +33,13 @@
"snippet::array-union": {
"id": "snippet::array-union",
"type": "simple",
"description": "You can use a combination of the spread operator and Set to create a union of two arrays.",
"description": "You can use a combination of the spread operator and `Set` to create a union of two arrays.",
"example": "const union = (a, b) => [...new Set([...a, ...b])]"
},
"snippet::array-unique": {
"id": "snippet::array-unique",
"type": "simple",
"description": "You can convert to and from a Set to remove duplicates from an array.",
"description": "You can convert to and from a `Set` to remove duplicates from an array.",
"example": "const unique = (arr) => [...new Set(arr)]"
},
"snippet::async-function-constructor": {
Expand All @@ -57,7 +57,7 @@
"snippet::call-bind": {
"id": "snippet::call-bind",
"type": "simple",
"description": "Every modern runtime provides a way to bind to the call method of a function.",
"description": "Every modern runtime provides a way to bind to the `call` method of a function.",
"example": "const fnBound = Function.call.bind(fn)"
},
"snippet::char-last": {
Expand All @@ -75,13 +75,13 @@
"snippet::get-iterator": {
"id": "snippet::get-iterator",
"type": "simple",
"description": "Every modern runtime provides a way to get the iterator function through the Symbol.iterator symbol.",
"description": "Every modern runtime provides a way to get the iterator function through the `Symbol.iterator` symbol.",
"example": "const iterator = obj[Symbol.iterator]?.()"
},
"snippet::has-argv": {
"id": "snippet::has-argv",
"type": "simple",
"description": "You can use the includes method on the process.argv array to check if a flag is present.",
"description": "You can use the `includes` method on the `process.argv` array to check if a flag is present.",
"example": "process.argv.includes('--flag')"
},
"snippet::is-arguments": {
Expand All @@ -93,7 +93,7 @@
"snippet::is-arraybuffer": {
"id": "snippet::is-arraybuffer",
"type": "simple",
"description": "You can use `instanceof ArrayBuffer`, or if cross-realm, use Object.prototype.toString.call(obj) === \"[object ArrayBuffer]\"",
"description": "You can use `instanceof ArrayBuffer`, or if cross-realm, use `Object.prototype.toString.call(obj) === \"[object ArrayBuffer]\"`",
"example": "const isArrayBuffer = obj instanceof ArrayBuffer;\n// for cross-realm\nconst isArrayBufferCrossRealm = Object.prototype.toString.call(obj) === \"[object ArrayBuffer]\""
},
"snippet::is-async-function": {
Expand All @@ -111,19 +111,19 @@
"snippet::is-boolean": {
"id": "snippet::is-boolean",
"type": "simple",
"description": "You can use typeof to check if a value is a boolean primitive, and Object.prototype.toString.call to check if it's a Boolean object.",
"description": "You can use `typeof` to check if a value is a boolean primitive, and `Object.prototype.toString.call` to check if it's a `Boolean` object.",
"example": "Object.prototype.toString.call(v) === \"[object Boolean]\""
},
"snippet::is-ci": {
"id": "snippet::is-ci",
"type": "simple",
"description": "Every major CI provider sets a CI environment variable that you can use to detect if you're running in a CI environment.",
"description": "Every major CI provider sets a `CI` environment variable that you can use to detect if you're running in a CI environment.",
"example": "Boolean(process.env.CI)"
},
"snippet::is-date": {
"id": "snippet::is-date",
"type": "simple",
"description": "You can use `instanceof Date`, or if cross-realm, use Object.prototype.toString.call(v) === \"[object Date]\"",
"description": "You can use `instanceof Date`, or if cross-realm, use `Object.prototype.toString.call(v) === \"[object Date]\"`",
"example": "const isDate = v instanceof Date;\n// for cross-realm\nconst isDateCrossRealm = Object.prototype.toString.call(v) === \"[object Date]\""
},
"snippet::is-even": {
Expand Down Expand Up @@ -159,7 +159,7 @@
"snippet::is-npm": {
"id": "snippet::is-npm",
"type": "simple",
"description": "If the current environment is npm the `npm_config_user_agent` environment variable will be set and start with \"npm\".",
"description": "If the current environment is npm the `npm_config_user_agent` environment variable will be set and start with `\"npm\"`.",
"example": "const isNpm = process.env.npm_config_user_agent?.startsWith(\"npm\")"
},
"snippet::is-object": {
Expand All @@ -183,7 +183,7 @@
"snippet::is-primitve": {
"id": "snippet::is-primitve",
"type": "simple",
"description": "You can check `typeof` of a value to determine if it's a primitive. Note that `typeof null` is \"object\" so you need to check for null separately.",
"description": "You can check `typeof` of a value to determine if it's a primitive. Note that `typeof null` is `\"object\"` so you need to check for `null` separately.",
"example": "const isPrimitive = (value) => value === null || (typeof value !== \"function\" && typeof value !== \"object\");"
},
"snippet::is-regexp": {
Expand Down Expand Up @@ -231,7 +231,7 @@
"snippet::json-file": {
"id": "snippet::json-file",
"type": "simple",
"description": "You can use `JSON` and 'node:fs' to read and write json file.",
"description": "You can use `JSON` and `node:fs` to read and write JSON files.",
"example": "import * as fs from 'node:fs/promises'\nfs.readFile(file, 'utf8').then(JSON.parse)\nfs.writeFile(file, JSON.stringify(data, null, 2) + '\\n')"
},
"snippet::math-random": {
Expand Down
16 changes: 8 additions & 8 deletions manifests/native.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,7 @@
"Object.assign": {
"id": "Object.assign",
"type": "native",
"description": "Object.assign, or if deep clones are needed, use structuredClone",
"description": "`Object.assign`, or if deep clones are needed, use `structuredClone`",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Global_Objects/Object/assign"
Expand Down Expand Up @@ -1404,7 +1404,7 @@
"es-errors": {
"id": "es-errors",
"type": "removal",
"description": "Error and its subclasses are natively built into all modern environments.",
"description": "`Error` and its subclasses are natively built into all modern environments.",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Global_Objects/Error"
Expand All @@ -1413,7 +1413,7 @@
"es-string-html-methods": {
"id": "es-string-html-methods",
"type": "removal",
"description": "All the methods exported by this modules are generally available on the String prototype in modern environments.",
"description": "All the methods exported by this modules are generally available on the `String` prototype in modern environments.",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Global_Objects/String#html_wrapper_methods"
Expand All @@ -1439,7 +1439,7 @@
"for...of": {
"id": "for...of",
"type": "native",
"description": "for...of (using \"Object.entries\" if dealing with objects)",
"description": "`for...of` (using `Object.entries` if dealing with objects)",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Statements/for...of"
Expand Down Expand Up @@ -1482,7 +1482,7 @@
"has-bigints": {
"id": "has-bigints",
"type": "removal",
"description": "Every modern environment has support for BigInt. You can just remove the check.",
"description": "Every modern environment has support for `BigInt`. You can just remove the check.",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Global_Objects/BigInt"
Expand All @@ -1491,7 +1491,7 @@
"has-dynamic-import": {
"id": "has-dynamic-import",
"type": "removal",
"description": "Every modern environment has support for dynamic import. You can just remove the check.",
"description": "Every modern environment has support for dynamic `import()`. You can just remove the check.",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Operators/import"
Expand All @@ -1518,7 +1518,7 @@
"has-proto": {
"id": "has-proto",
"type": "removal",
"description": "Every modern environment has support for __proto__. You can just remove the check.",
"description": "Every modern environment has support for `__proto__`. You can just remove the check.",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Operators/Object_initializer#prototype_setter"
Expand All @@ -1527,7 +1527,7 @@
"has-symbols": {
"id": "has-symbols",
"type": "removal",
"description": "Every modern environment has support for Symbols. You can just remove the check.",
"description": "Every modern environment has support for `Symbol`. You can just remove the check.",
"url": {
"type": "mdn",
"id": "Web/JavaScript/Reference/Global_Objects/Symbol"
Expand Down
4 changes: 1 addition & 3 deletions manifests/preferred.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2999,7 +2999,6 @@
"fs": {
"id": "fs",
"type": "native",
"description": "Node file system module",
"nodeFeatureId": {"moduleName": "node:fs"},
"url": {"type": "node", "id": "api/fs.html"}
},
Expand Down Expand Up @@ -3288,7 +3287,6 @@
"readline.createInterface": {
"id": "readline.createInterface",
"type": "native",
"description": "readline.createInterface",
"nodeFeatureId": {
"moduleName": "node:readline",
"exportName": "createInterface"
Expand All @@ -3307,7 +3305,7 @@
"sort-object": {
"id": "sort-object",
"type": "removal",
"description": "Object.entries and Array.prototype.sort can be used to sort object keys.",
"description": "`Object.entries` and `Array.prototype.sort` can be used to sort object keys.",
"url": {"type": "e18e", "id": "sort-object"}
},
"sort-object-keys": {
Expand Down