| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 30e3818 commit c8dac32
3 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3524,13 +3524,13 @@ changes: | |||
| 3524 | 3524 | calculations with them. | |
| 3525 | 3525 | --> | |
| 3526 | 3526 | ||
| 3527 | + > Stability: 0 - Deprecated: Use [`buf.subarray`][] instead. | ||
| 3528 | + | ||
| 3527 | 3529 | * `start` {integer} Where the new `Buffer` will start. **Default:** `0`. | |
| 3528 | 3530 | * `end` {integer} Where the new `Buffer` will end (not inclusive). | |
| 3529 | 3531 | **Default:** [`buf.length`][]. | |
| 3530 | 3532 | * Returns: {Buffer} | |
| 3531 | 3533 | ||
| 3532 | - > Stability: 0 - Deprecated: Use [`buf.subarray`][] instead. | ||
| 3533 | - | ||
| 3534 | 3534 | Returns a new `Buffer` that references the same memory as the original, but | |
| 3535 | 3535 | offset and cropped by the `start` and `end` indexes. | |
| 3536 | 3536 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -18,10 +18,10 @@ For more details refer to the [`process.env` documentation][]. | |||
| 18 | 18 | ||
| 19 | 19 | ## DotEnv | |
| 20 | 20 | ||
| 21 | - Set of utilities for dealing with additional environment variables defined in `.env` files. | ||
| 22 | - | ||
| 23 | 21 | > Stability: 2 - Stable | |
| 24 | 22 | ||
| 23 | + Set of utilities for dealing with additional environment variables defined in `.env` files. | ||
| 24 | + | ||
| 25 | 25 | ### .env files | |
| 26 | 26 | ||
| 27 | 27 | `.env` files (also known as dotenv files) are files that define environment variables, | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,52 @@ | |||
| 1 | + import '../common/index.mjs'; | ||
| 2 | + | ||
| 3 | + import fs from 'fs'; | ||
| 4 | + import assert from 'assert'; | ||
| 5 | + | ||
| 6 | + import { | ||
| 7 | + remarkParse, | ||
| 8 | + unified, | ||
| 9 | + } from '../../tools/doc/deps.mjs'; | ||
| 10 | + | ||
| 11 | + const ignore = ['deprecations.md', 'documentation.md']; | ||
| 12 | + | ||
| 13 | + const docURL = new URL('../../doc/api/', import.meta.url); | ||
| 14 | + const docList = fs.readdirSync(docURL).filter((filename) => !ignore.includes(filename)); | ||
| 15 | + | ||
| 16 | + const re = /^Stability: \d/; | ||
| 17 | + | ||
| 18 | + for (const file of docList) { | ||
| 19 | + const fileURL = new URL(file, docURL); | ||
| 20 | + const tree = unified() | ||
| 21 | + .use(remarkParse) | ||
| 22 | + .parse(fs.readFileSync(fileURL)); | ||
| 23 | + | ||
| 24 | + // Traverse first-level nodes, ignoring comment blocks | ||
| 25 | + const nodes = tree.children.filter((node) => node.type !== 'html'); | ||
| 26 | + | ||
| 27 | + for (let i = 0; i < nodes.length; i++) { | ||
| 28 | + const { [i]: node, [i - 1]: previousNode } = nodes; | ||
| 29 | + if (node.type !== 'blockquote' || !node.children.length) continue; | ||
| 30 | + | ||
| 31 | + const paragraph = node.children[0]; | ||
| 32 | + if (paragraph.type !== 'paragraph' || !paragraph.children.length) continue; | ||
| 33 | + | ||
| 34 | + const text = paragraph.children[0]; | ||
| 35 | + if (text.type !== 'text' || !re.exec(text.value)) continue; | ||
| 36 | + | ||
| 37 | + // Check that previous node type (excluding comment blocks) is one of: | ||
| 38 | + // * 'heading' | ||
| 39 | + // * 'paragraph' with a leading 'strong' node (pseudo-heading, eg. assert.equal) | ||
| 40 | + try { | ||
| 41 | + assert(previousNode.type === 'heading' || | ||
| 42 | + (previousNode.type === 'paragraph' && previousNode.children[0]?.type === 'strong'), | ||
| 43 | + 'Stability block must be the first content element under heading'); | ||
| 44 | + } catch (error) { | ||
| 45 | + const { line, column } = node.position.start; | ||
| 46 | + error.stack = error.stack.split('\n') | ||
| 47 | + .toSpliced(1, 0, ` at ${fileURL}:${line}:${column}`) | ||
| 48 | + .join('\n'); | ||
| 49 | + throw error; | ||
| 50 | + } | ||
| 51 | + } | ||
| 52 | + } | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments