fix stability

Author: avivkeller

src/generators/jsx-ast/test/utils.test.mjs

@@ -48,7 +48,9 @@ test('buildMetaBarProps includes expected fields', () => {
   assert.deepEqual(result.viewAs, [['JSON', 'sample-api.json']]);
   assert.ok(result.readingTime.startsWith('1 min'));
   assert.ok(result.editThisPage.endsWith('sample-api.md'));
-  assert.deepEqual(result.headings, [{ depth: 2, value: 'SampleFunc' }]);
+  assert.deepEqual(result.headings, [
+    { depth: 2, value: 'SampleFunc', data: { id: 'sample-func' } },
+  ]);
 });
 
 test('createJSXElement builds correct JSX tree', () => {

src/generators/jsx-ast/utils/buildContent.mjs

@@ -86,7 +86,7 @@ const createSourceLink = sourceLink => {
 const transformStabilityNode = ({ data }, index, parent) => {
   parent.children[index] = createJSXElement(JSX_IMPORTS.AlertBox.name, {
     children: data.description,
-    level: STABILITY_LEVELS[data.index],
+    level: STABILITY_LEVELS[parseInt(data.index)],
     title: data.index,
   });
 

src/generators/legacy-html/utils/buildContent.mjs

@@ -53,7 +53,7 @@ const buildStability = ({ children, data }, index, parent) => {
     // Creates the `div` element with the class `api_stability` and the stability index class
     // FYI: Since the Stability Index `blockquote` node gets modified within `queries.mjs`
     // it contains the StabilityIndexMetadataEntry within the `data` property
-    `div.api_stability.api_stability_${data.index}`,
+    `div.api_stability.api_stability_${parseInt(data.index)}`,
     // Processed the Markdown nodes into HTML nodes
     children
   );

src/generators/legacy-html/utils/buildExtraContent.mjs

@@ -26,7 +26,7 @@ const buildStabilityOverview = headMetadata => {
           createElement('a', { href: `${api}.html` }, heading.data.name)
         ),
         createElement(
-          `td.api_stability.api_stability_${data.index}`,
+          `td.api_stability.api_stability_${parseInt(data.index)}`,
           // Grabs the first sentence of the description
           // to be used as a summary of the Stability Index
           `(${data.index}) ${data.description.split('. ')[0]}`

src/generators/legacy-html/utils/tableOfContents.mjs

@@ -53,7 +53,7 @@ tableOfContents.parseToCNode = ({ stability, api, heading }) => {
     const [firstStability] = stability.children;
 
     return (
-      `<span class="stability_${firstStability.data.index}">` +
+      `<span class="stability_${parseInt(firstStability.data.index)}">` +
       `<a href="${fullSlug}">${heading.data.text}</a></span>`
     );
   }

src/generators/legacy-json/types.d.ts

@@ -78,7 +78,7 @@ export interface SectionBase {
   /**
    * Stability index of the section.
    */
-  stability?: number;
+  stability?: string;
 
   /**
    * Descriptive text related to the stability of the section (E.G. "Experimental").

src/generators/web/components/CodeBox.jsx

@@ -7,7 +7,7 @@ const MDXCodeBox = ({ className, ...props }) => {
   const language = matches?.groups?.language ?? '';
   const [copyText, setCopyText] = useState('Copy to clipboard');
 
-  const handleCopy = async (text) => {
+  const handleCopy = async text => {
     await navigator.clipboard.writeText(text);
 
     setCopyText('Copied to clipboard!');

src/types.d.ts

@@ -10,7 +10,7 @@ interface NodeWithData<T extends Node, J extends Data> extends T {
 
 declare global {
   export interface StabilityIndexMetadataEntry {
-    index: number;
+    index: string;
     description: string;
   }
 

src/utils/queries/index.mjs

@@ -134,7 +134,7 @@ const createQueries = () => {
       // so that the original node data can also be inferred
       node.data = {
         // The 2nd match should be the group that matches the Stability Index
-        index: Number(matches[1]),
+        index: matches[1],
         // The 3rd match should be the group containing all the remaining text
         // which is used as a description (we trim it to an one liner)
         description: matches[2].replace(/\n/g, ' ').trim(),
@@ -190,9 +190,9 @@ createQueries.QUERIES = {
   // so that they can be transformed into HTML links
   linksWithTypes: /\[`<([a-zA-Z0-9.| \\[\]]+)>`\]\((\S+)\)/g,
   // ReGeX for handling Stability Indexes Metadata
-  stabilityIndex: /^Stability: ([0-5])(?:\s*-\s*)?(.*)$/s,
+  stabilityIndex: /^Stability: ([0-5](?:\.[0-3])?)(?:\s*-\s*)?(.*)$/s,
   // ReGeX for handling the Stability Index Prefix
-  stabilityIndexPrefix: /Stability: ([0-5])/,
+  stabilityIndexPrefix: /Stability: ([0-5](?:\.[0-3])?)/,
   // ReGeX for retrieving the inner content from a YAML block
   yamlInnerContent: /^<!--[ ]?(?:YAML([\s\S]*?)|([ \S]*?))?[ ]?-->/,
 };

src/utils/tests/queries.test.mjs

@@ -96,14 +96,14 @@ describe('createQueries', () => {
       children: [
         {
           type: 'paragraph',
-          children: [{ type: 'text', value: 'Stability: 2 - Frozen' }],
+          children: [{ type: 'text', value: 'Stability: 1.0 - Frozen' }],
         },
       ],
     };
     const apiEntryMetadata = {
       addStability: stability => {
         deepStrictEqual(stability.data, {
-          index: 2,
+          index: '1.0',
           description: 'Frozen',
         });
       },