@patternfly/documentation-framework 1.4.16 → 1.5.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 1.5.0 (2023-02-02)
+
+
+### Features
+
+* add deprecated subpaths ([#3291](https://github.com/patternfly/patternfly-org/issues/3291)) ([b4324a7](https://github.com/patternfly/patternfly-org/commit/b4324a7ef10123a37ad8334e3b3da8be76fc35dc))
+
+
+
+
+
 ## 1.4.16 (2023-02-02)
 
 

package/components/example/example.js

@@ -3,7 +3,9 @@ import { useLocation } from '@reach/router';
 import { Badge, CodeBlock, CodeBlockCode, debounce, Switch } from '@patternfly/react-core';
 import * as reactCoreModule from '@patternfly/react-core';
 import * as reactCoreNextModule from '@patternfly/react-core/next';
+import * as reactCoreDeprecatedModule from '@patternfly/react-core/deprecated';
 import * as reactTableModule from '@patternfly/react-table';
+import * as reactTableDeprecatedModule from '@patternfly/react-table/deprecated';
 import { css } from '@patternfly/react-styles';
 import { getParameters } from 'codesandbox/lib/api/define';
 import { ExampleToolbar } from './exampleToolbar';
@@ -109,7 +111,8 @@ export const Example = ({
     // These 2 are in the bundle anyways for the site since we dogfood
     ...reactCoreModule,
     ...reactTableModule,
-    ...(source === 'react-next' ? reactCoreNextModule : {})
+    ...(source === 'react-next' ? reactCoreNextModule : {}),
+    ...(source === 'react-deprecated' ? {...reactCoreDeprecatedModule, ...reactTableDeprecatedModule} : {})
   };
 
   let livePreview = null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "1.4.16",
+  "version": "1.5.0",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -84,5 +84,5 @@
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },
-  "gitHead": "2ce8862258970ecf26c85eae9813bc75d9809f6f"
+  "gitHead": "8766a0630ac46ef293f0edc0ce2cd4b3cd095104"
 }

package/routes.js

@@ -65,7 +65,8 @@ const sourceOrder = {
   react: 1,
   'react-next': 1.1,
   'react-composable': 1.2,
-  'react-legacy': 1.3,
+  'react-deprecated': 1.3,
+  'react-legacy': 1.4,
   'react-demos': 2,
   html: 3,
   'html-demos': 4,

package/scripts/md/parseMD.js

@@ -61,7 +61,7 @@ function toReactComponent(mdFilePath, source, buildMode) {
       }
 
       const propComponents = [...new Set(frontmatter.propComponents || [])].reduce((acc, componentName) => {
-        const name = getTsDocName(componentName, source === 'react-next');
+        const name = getTsDocName(componentName, getTsDocNameVariant(source));
 
         if (tsDocs[name]) {
           acc.push(tsDocs[name]);
@@ -242,7 +242,7 @@ function sourcePropsFile(file) {
   tsDocgen(file)
     .filter(({ hide }) => !hide)
     .forEach(({ name, description, props }) => {
-      tsDocs[getTsDocName(name, file.includes('/next'))] = { name, description, props };
+      tsDocs[getTsDocName(name, getTsDocNameVariant(file))] = { name, description, props };
     });
 }
 
@@ -283,10 +283,20 @@ function writeIndex() {
   return exitCode;
 }
 
-// Build unique names for components if they are a part of the "next" module.
-function getTsDocName(name, isNextComponent) {
-  return `${name}${isNextComponent ? '-next' : ''}`;
-};
+// Build unique names for components with a "variant" extension
+function getTsDocName(name, variant) {
+  return `${name}${variant ? `-${variant}` : ''}`;
+}
+
+function getTsDocNameVariant(source) {
+  if (source.includes('next')) {
+    return 'next';
+  }
+
+  if (source.includes('deprecated')) {
+    return 'deprecated';
+  }
+}
 
 module.exports = {
   sourceProps(glob, ignore) {

package/scripts/md/typecheck.js

@@ -38,6 +38,8 @@ const defaultImports = [
   'react',
   '@reach/router',
   '@patternfly/react-core/next',
+  '@patternfly/react-core/deprecated',
+  '@patternfly/react-table/deprecated',
   'react-dropzone',
 ];
 const files = {

package/scripts/webpack/webpack.base.config.js

@@ -118,8 +118,7 @@ module.exports = (_env, argv) => {
       alias: {
         'client-styles': path.resolve(process.cwd(), 'patternfly-docs/patternfly-docs.css.js'),
         './routes-client': path.resolve(process.cwd(), 'patternfly-docs/patternfly-docs.routes.js'),
-        './routes-generated': path.resolve(process.cwd(), 'patternfly-docs/generated/index.js'),
-        '@patternfly/react-core/next': '@patternfly/react-core/dist/esm/next/index.js' // Can remove when webpack is updated to v5
+        './routes-generated': path.resolve(process.cwd(), 'patternfly-docs/generated/index.js')
       },
       modules: [
         'node_modules',