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
13 changes: 13 additions & 0 deletions .oxfmtrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@
"bracketSameLine": false,
"arrowParens": "avoid",
"sortPackageJson": false,
"sortImports": {
"groups": [
"builtin",
"external",
"internal",
["sibling", "parent"],
"index",
"unknown"
],
"newlinesBetween": true,
"order": "asc",
"ignoreCase": true
},
"ignorePatterns": [
"pnpm-lock.yaml",
"packages/node/src/api-links/__tests__/fixtures/",
Expand Down
24 changes: 1 addition & 23 deletions .oxlintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
"plugins": ["import"],
"jsPlugins": [
"eslint-plugin-react-x",
{
"name": "import-x-js",
"specifier": "eslint-plugin-import-x"
},
{
"name": "jsdoc-js",
"specifier": "eslint-plugin-jsdoc"
Expand Down Expand Up @@ -148,25 +144,7 @@
"curly": ["error", "all"],
"import/namespace": "off",
"import/no-named-as-default": "off",
"import/no-named-as-default-member": "off",
"import-x-js/order": [
"error",
{
"groups": [
"builtin",
"external",
"internal",
["sibling", "parent"],
"index",
"unknown"
],
"newlines-between": "always",
"alphabetize": {
"order": "asc",
"caseInsensitive": true
}
}
]
"import/no-named-as-default-member": "off"
},
"jsPlugins": ["eslint-plugin-react-x"],
"globals": {
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
"@types/node": "~24.10.1",
"@types/semver": "~7.8.0",
"c8": "~12.0.0",
"eslint-plugin-import-x": "4.17.1",
"eslint-plugin-jsdoc": "64.3.1",
"eslint-plugin-react-x": "5.18.6",
"husky": "9.1.7",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/generators/metadata/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { Position } from 'unist';
import type { Root, Node, Data, Blockquote, Heading } from 'mdast';
import type { Position } from 'unist';

export type Generator = GeneratorMetadata<
{},
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/utils/configuration/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { SemVer } from 'semver';

import type { ReleaseEntry } from '#parsers/types';

export type Configuration = {
Expand Down
2 changes: 1 addition & 1 deletion packages/node-legacy/src/legacy-html-all/index.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
'use strict';

import { generate } from './generate.mjs';
import legacyHtml from '../legacy-html/index.mjs';
import { generate } from './generate.mjs';

/**
* This generator generates the legacy HTML pages of the legacy API docs
Expand Down
2 changes: 1 addition & 1 deletion packages/node-legacy/src/legacy-json/generate.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import getConfig from '@doc-kit/core/utils/configuration/index.mjs';
import { writeFile, withExt } from '@doc-kit/core/utils/file.mjs';
import { groupNodesByModule } from '@doc-kit/core/utils/generators.mjs';

import { createSectionBuilder } from './utils/buildSection.mjs';
import { legacyToJSON } from '../utils/legacyToJSON.mjs';
import { createSectionBuilder } from './utils/buildSection.mjs';

const buildSection = createSectionBuilder();

Expand Down
2 changes: 1 addition & 1 deletion packages/node-legacy/src/legacy-json/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ListItem } from '@types/mdast';
import { MetadataEntry } from '@doc-kit/core/generators/metadata/types';
import { MethodSignature } from '@doc-kit/core/utils/signature/types';
import { ListItem } from '@types/mdast';

/**
* Contains metadata related to changes, additions, removals, and deprecated statuses of an entry.
Expand Down
5 changes: 3 additions & 2 deletions packages/react/src/html/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import type { PageCode } from '../jsx-ast/types';
import type { GlobalConfiguration } from '@doc-kit/core/utils/configuration/types';
import type SideBar from '@node-core/ui-components/Containers/Sidebar';
import type NavBar from '@node-core/ui-components/Containers/NavBar';
import type SideBar from '@node-core/ui-components/Containers/Sidebar';
import type { ComponentProps } from 'preact';

import type { PageCode } from '../jsx-ast/types';

// An attribute bag rendered into an HTML tag. `true` becomes a valueless
// attribute (e.g. `crossorigin`); `false`/`null`/`undefined` are omitted.
export type TagAttributes = Record<
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/html/ui/components/Banner.jsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { ArrowUpRightIcon } from '@heroicons/react/24/outline';
import Banner from '@node-core/ui-components/Common/Banner';

import { version } from '#theme/config';

import useBanners from '../hooks/useBanners.mjs';
import useRemoteConfig from '../hooks/useRemoteConfig.mjs';
import withIsland from '../islands/withIsland.jsx';

import { version } from '#theme/config';

const Banners = () => {
const remote = useRemoteConfig();
const [banner, dismissBanner] = useBanners(
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/html/ui/components/CodeBox.jsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import BaseCodeBox from '@node-core/ui-components/Common/BaseCodeBox';

import withIsland from '../islands/withIsland.jsx';

import { languageDisplayNameMap } from '#theme/config';

import withIsland from '../islands/withIsland.jsx';

/**
* Get the display name of a language
* @param {string} language - The language ID
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import Badge from '@node-core/ui-components/Common/Badge';

import styles from './index.module.css';
import { STABILITY_KINDS, STABILITY_LABELS } from '../constants.mjs';

import { documentationIndex } from '#theme/config';

import { STABILITY_KINDS, STABILITY_LABELS } from '../constants.mjs';
import styles from './index.module.css';

/**
* @typedef {Object} DocumentationIndexEntry
* @property {string} api - Basename of the document, linked as `${api}.html`
Expand Down
10 changes: 5 additions & 5 deletions packages/react/src/html/ui/components/Layout/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ import CrossLink from '@node-core/ui-components/Common/BaseCrossLink';
import TableOfContents from '@node-core/ui-components/Common/TableOfContents';
import Article from '@node-core/ui-components/Containers/Article';

import Banner from '../Banner';
import styles from './index.module.css';
import { relativeOrAbsolute } from '../../utils/relativeOrAbsolute.mjs';
import { renderLabel } from '../../utils/renderLabel';

import { navigation, chunks } from '#theme/config';
import Footer from '#theme/Footer';
import MetaBar from '#theme/Metabar';
import NavBar from '#theme/Navigation';
import SideBar from '#theme/Sidebar';

import { relativeOrAbsolute } from '../../utils/relativeOrAbsolute.mjs';
import { renderLabel } from '../../utils/renderLabel';
import Banner from '../Banner';
import styles from './index.module.css';

/**
* Flattens a section tree into document order.
*
Expand Down
6 changes: 3 additions & 3 deletions packages/react/src/html/ui/components/MetaBar/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import Badge from '@node-core/ui-components/Common/Badge';
import MetaBar from '@node-core/ui-components/Containers/MetaBar';
import GitHubIcon from '@node-core/ui-components/Icons/Social/GitHub';

import styles from './index.module.css';
import { editURL, chunks } from '#theme/config';

import { relativeOrAbsolute } from '../../utils/relativeOrAbsolute.mjs';
import { STABILITY_KINDS, STABILITY_LABELS } from '../constants.mjs';

import { editURL, chunks } from '#theme/config';
import styles from './index.module.css';

const iconMap = {
JSON: CodeBracketIcon,
Expand Down
6 changes: 3 additions & 3 deletions packages/react/src/html/ui/components/NavBar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ import NavBar from '@node-core/ui-components/Containers/NavBar';
import styles from '@node-core/ui-components/Containers/NavBar/index.module.css';
import GitHubIcon from '@node-core/ui-components/Icons/Social/GitHub';

import SearchBox from './SearchBox';
import ThemeToggle from './ThemeToggle.jsx';

import { repository, showSearchBox, navigation } from '#theme/config';
import Logo from '#theme/Logo';

import SearchBox from './SearchBox';
import ThemeToggle from './ThemeToggle.jsx';

/**
* NavBar component that displays the headings, search, etc.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import SearchModal from '@node-core/ui-components/Common/Search/Modal';
import SearchResults from '@node-core/ui-components/Common/Search/Results';
import SearchHit from '@node-core/ui-components/Common/Search/Results/Hit';

import styles from './index.module.css';
import useOrama from '../../hooks/useOrama.mjs';
import withIsland from '../../islands/withIsland.jsx';
import { relativeOrAbsolute } from '../../utils/relativeOrAbsolute.mjs';
import styles from './index.module.css';

/**
* Dismisses the search modal the clicked hit sits in
Expand Down
12 changes: 6 additions & 6 deletions packages/react/src/html/ui/components/SideBar/index.jsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
import Select from '@node-core/ui-components/Common/Select';
import SideBar from '@node-core/ui-components/Containers/Sidebar';

import styles from './index.module.css';
import useRemoteConfig from '../../hooks/useRemoteConfig.mjs';
import withIsland from '../../islands/withIsland.jsx';
import { relativeOrAbsolute } from '../../utils/relativeOrAbsolute.mjs';
import { renderLabel } from '../../utils/renderLabel.jsx';

import {
project,
version,
Expand All @@ -16,6 +10,12 @@ import {
chunks,
} from '#theme/config';

import useRemoteConfig from '../../hooks/useRemoteConfig.mjs';
import withIsland from '../../islands/withIsland.jsx';
import { relativeOrAbsolute } from '../../utils/relativeOrAbsolute.mjs';
import { renderLabel } from '../../utils/renderLabel.jsx';
import styles from './index.module.css';

/**
* Extracts the major version number from a version string.
* @param {string} v - Version string (e.g., 'v14.0.0', '14.0.0')
Expand Down
5 changes: 3 additions & 2 deletions packages/react/src/html/ui/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { GlobalConfiguration } from '@doc-kit/core/utils/configuration/types';
import { MetadataEntry } from '@doc-kit/core/generators/metadata/types';
import { Configuration } from '../types';
import { GlobalConfiguration } from '@doc-kit/core/utils/configuration/types';
import { SemVer } from 'semver';

import { Configuration } from '../types';

declare module '#theme/config' {
// From global configuration
export const repository: GlobalConfiguration['repository'];
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/html/utils/processing.mjs
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import getConfig from '@doc-kit/core/utils/configuration/index.mjs';
import { populate } from '@doc-kit/core/utils/configuration/templates.mjs';

import createConfigSource from './config.mjs';
import { relativeOrAbsolute } from './relativeOrAbsolute.mjs';
import { FONT_DIRECTORY, FONTS, SPECULATION_RULES } from '../constants.mjs';
import { THEME_SCRIPT } from '../ui/theme-script.mjs';
import createConfigSource from './config.mjs';
import { relativeOrAbsolute } from './relativeOrAbsolute.mjs';

/**
* Creates the virtual imports for one bundle target.
Expand Down
1 change: 1 addition & 0 deletions packages/react/src/jsx-ast/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { MetadataEntry } from '@doc-kit/core/generators/metadata/types';

import type { PageContent } from './utils/buildContent.mjs';

// What the worker returns for a page: the fragment serialized to JSX code.
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/jsx-ast/utils/buildBarProps.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

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

import { getFullName } from './signature.mjs';
import { TOC_MAX_HEADING_DEPTH } from '../constants.mjs';
import { getFullName } from './signature.mjs';

// Callable heading types whose ToC label should be the bare function name
// rather than the full signature.
Expand Down
8 changes: 4 additions & 4 deletions packages/react/src/jsx-ast/utils/buildContent.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ import { slice } from 'mdast-util-slice-markdown';
import { u as createTree } from 'unist-builder';
import { SKIP, visit } from 'unist-util-visit';

import { createJSXElement } from './ast.mjs';
import { extractHeadings, extractTextContent } from './buildBarProps.mjs';
import { getRemarkRecma as remark } from './remark.mjs';
import { renderAsJSX } from './render.mjs';
import { JSX_IMPORTS } from '../../html/constants.mjs';
import {
STABILITY_LEVELS,
Expand All @@ -30,6 +26,10 @@ import {
TYPES_WITH_METHOD_SIGNATURES,
TYPE_PREFIX_LENGTH,
} from '../constants.mjs';
import { createJSXElement } from './ast.mjs';
import { extractHeadings, extractTextContent } from './buildBarProps.mjs';
import { getRemarkRecma as remark } from './remark.mjs';
import { renderAsJSX } from './render.mjs';
import {
insertSignatureCodeBlock,
createSignatureTable,
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/jsx-ast/utils/signature.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import { parseListItem } from '@doc-kit/core/utils/signature/parseList.mjs';
import parseSignature from '@doc-kit/core/utils/signature/parseSignature.mjs';
import { h as createElement } from 'hastscript';

import { JSX_IMPORTS } from '../../html/constants.mjs';
import { createJSXElement } from './ast.mjs';
import { parseListIntoProperties } from './types.mjs';
import { JSX_IMPORTS } from '../../html/constants.mjs';

/**
* Generates a string representation of a function or class signature.
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/orama-db/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { Orama, RawData } from '@orama/orama';
import type { MetadataEntry } from '@doc-kit/core/generators/metadata/types';
import type { Orama, RawData } from '@orama/orama';

/**
* Schema for the Orama database entry
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/section-pages/generate.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import getConfig from '@doc-kit/core/utils/configuration/index.mjs';
import { groupNodesByModule } from '@doc-kit/core/utils/generators.mjs';
import { visit } from 'unist-util-visit';

import { headingLabel } from '../jsx-ast/utils/buildBarProps.mjs';
import { MIN_CHUNKS } from './constants.mjs';
import { buildAnchorMap, rewriteUrl } from './utils/links.mjs';
import { createUniqueNamer, toFileName } from './utils/naming.mjs';
import { splitIntoChunks } from './utils/split.mjs';
import { headingLabel } from '../jsx-ast/utils/buildBarProps.mjs';

// The nodes that carry a URL authored relative to the module page
const URL_NODE_TYPES = new Set(['link', 'image', 'definition']);
Expand Down
Loading
Loading