Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
420 changes: 0 additions & 420 deletions src/constants.mjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/generators/json-simple/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { join } from 'node:path';

import { remove } from 'unist-util-remove';

import createQueries from '../../queries.mjs';
import createQueries from '../../utils/queries/index.mjs';
import { getRemark } from '../../utils/remark.mjs';

/**
Expand Down
12 changes: 12 additions & 0 deletions src/generators/legacy-html/constants.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
'use strict';

// This is the Node.js Base URL for viewing a file within GitHub UI
export const DOC_NODE_BLOB_BASE_URL =
'https://github.com/nodejs/node/blob/HEAD/';

// This is the Node.js API docs base URL for editing a file on GitHub UI
export const DOC_API_BLOB_EDIT_BASE_URL =
'https://github.com/nodejs/node/edit/main/doc/api/';

// Base URL for a specific Node.js version within the Node.js API docs
export const DOC_API_BASE_URL_VERSION = 'https://nodejs.org/docs/latest-v';
4 changes: 2 additions & 2 deletions src/generators/legacy-html/utils/buildContent.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import { SKIP, visit } from 'unist-util-visit';

import buildExtraContent from './buildExtraContent.mjs';

import createQueries from '../../../queries.mjs';
import createQueries from '../../../utils/queries/index.mjs';

import { DOC_NODE_BLOB_BASE_URL } from '../../../constants.mjs';
import { DOC_NODE_BLOB_BASE_URL } from '../constants.mjs';

/**
* Builds a Markdown heading for a given node
Expand Down
2 changes: 1 addition & 1 deletion src/generators/legacy-html/utils/buildDropdowns.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
import {
DOC_API_BASE_URL_VERSION,
DOC_API_BLOB_EDIT_BASE_URL,
} from '../../../constants.mjs';
} from '../constants.mjs';

/**
* Builds the Dropdown for the current Table of Contents
Expand Down
11 changes: 11 additions & 0 deletions src/generators/man-page/constants.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
'use strict';

// https://github.com/nodejs/node/blob/main/doc/api/cli.md#options
// This slug should reference the section where the available
// options are defined.
export const DOC_SLUG_OPTIONS = 'options';

// https://github.com/nodejs/node/blob/main/doc/api/cli.md#environment-variables-1
// This slug should reference the section where the available
// environment variables are defined.
export const DOC_SLUG_ENVIRONMENT = 'environment-variables-1';
2 changes: 1 addition & 1 deletion src/generators/man-page/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
convertEnvVarToMandoc,
} from './utils/converter.mjs';

import { DOC_SLUG_ENVIRONMENT, DOC_SLUG_OPTIONS } from '../../constants.mjs';
import { DOC_SLUG_ENVIRONMENT, DOC_SLUG_OPTIONS } from './constants.mjs';

/**
* This generator generates a man page version of the CLI.md file.
Expand Down
7 changes: 7 additions & 0 deletions src/linter/constants.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'use strict';

export const LINT_MESSAGES = {
missingIntroducedIn: "Missing 'introduced_in' field in the API doc entry",
missingChangeVersion: 'Missing version field in the API doc entry',
invalidChangeVersion: 'Invalid version number: {{version}}',
};
2 changes: 1 addition & 1 deletion src/linter/rules/invalid-change-version.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { LINT_MESSAGES } from '../../constants.mjs';
import { LINT_MESSAGES } from '../constants.mjs';
import { valid } from 'semver';

/**
Expand Down
2 changes: 1 addition & 1 deletion src/linter/rules/missing-introduced-in.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { LINT_MESSAGES } from '../../constants.mjs';
import { LINT_MESSAGES } from '../constants.mjs';

/**
* Checks if `introduced_in` field is missing
Expand Down
4 changes: 2 additions & 2 deletions src/parsers/markdown.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import { selectAll } from 'unist-util-select';
import { SKIP, visit } from 'unist-util-visit';

import createMetadata from '../metadata.mjs';
import createQueries from '../queries.mjs';
import createQueries from '../utils/queries/index.mjs';

import { getRemark } from '../utils/remark.mjs';
import { createNodeSlugger } from '../utils/slugger.mjs';
import { createNodeSlugger } from '../utils/slugger/index.mjs';

/**
* Creates an API doc parser for a given Markdown API doc file
Expand Down
Loading
Loading