Adding vault content inclusion exclusions

.gitignore

@@ -61,3 +61,7 @@ tfe-releases-repos.json
 scripts/prebuild/prebuild-arm-mac-binary
 scripts/prebuild/prebuild-x64-linux-binary
 scripts/prebuild/prebuild-arm-linux-binary
+
+scripts/prebuild/mdx-transforms/benchmarks
+
+scripts/prebuild/mdx-transforms/content-exclusion-OOP-approach

content/vault/v1.20.x/content/docs/concepts/client-count/test-vault-exclusion.mdx

@@ -0,0 +1,25 @@
+---
+  page_title: Test Vault Content Exclusion yoo
+---
+
+# Test Vault Content Exclusion
+
+This content should always appear.
+
+<!-- BEGIN: Vault:>=v1.21.x -->
+This content should be REMOVED because current version (1.20.x) is less than 1.21.x
+<!-- END: Vault:>=v1.21.x -->
+
+<!-- BEGIN: Vault:<=v1.21.x -->
+This content should STAY because current version (1.20.x) is less than or equal to 1.21.x
+<!-- END: Vault:<=v1.21.x -->
+
+<!-- BEGIN: Vault:=v1.20.x -->
+This content should STAY because current version equals 1.20.x
+<!-- END: Vault:=v1.20.x -->
+
+<!-- BEGIN: Vault:<v1.19.x -->
+This content shofuld be REMOVED because current version (1.20.x) is not less than 1.19.x
+<!-- END: Vault:<v1.19.x -->
+
+Final content that should always appear.

productConfig.mjs

@@ -175,6 +175,7 @@ export const PRODUCT_CONFIG = {
 		contentDir: 'docs',
 		dataDir: 'data',
 		productSlug: 'terraform',
+		supportsExclusionDirectives: true,
 		/**
 		 * Note: we need to sort versions for various reasons. Nearly all
 		 * our documentation is semver-versioned. PTFE is not. Rather than
@@ -310,6 +311,7 @@ export const PRODUCT_CONFIG = {
 		semverCoerce: semver.coerce,
 		versionedDocs: false,
 		websiteDir: 'website',
+		supportsExclusionDirectives: true,
 	},
 	'terraform-plugin-framework': {
 		/**
@@ -450,6 +452,7 @@ export const PRODUCT_CONFIG = {
 		semverCoerce: semver.coerce,
 		versionedDocs: true,
 		websiteDir: 'website',
+		supportsExclusionDirectives: true,
 	},
 	'well-architected-framework': {
 		/**

scripts/prebuild/mdx-transforms/build-mdx-transforms-file.mjs

@@ -18,7 +18,8 @@ import {
 	rewriteInternalRedirectsPlugin,
 	loadRedirects,
 } from './rewrite-internal-redirects/rewrite-internal-redirects.mjs'
-import { transformExcludeTerraformContent } from './exclude-terraform-content/index.mjs'
+import { transformExcludeContent } from './exclude-content/index.mjs'
+import { PRODUCT_CONFIG } from '#productConfig.mjs'
 
 const CWD = process.cwd()
 const VERSION_METADATA_FILE = path.join(CWD, 'app/api/versionMetadata.json')
@@ -86,10 +87,28 @@ export async function applyFileMdxTransforms(entry, versionMetadata = {}) {
 
 		const { data, content } = grayMatter(fileString)
 
-		const remarkResults = await remark()
+		// Check if this file is in a global/partials directory
+		// Global partials should not have content exclusion applied to them
+		// as they are version-agnostic and shared across all versions
+		const isGlobalPartial = filePath.includes('/global/partials/')
+
+		const processor = remark()
 			.use(remarkMdx)
-			.use(transformExcludeTerraformContent, { filePath })
+			// Process partials first, then content exclusion
+			// This ensures exclusion directives in global partials are properly evaluated
 			.use(remarkIncludePartialsPlugin, { partialsDir, filePath })
+
+		// Only apply content exclusion if this is NOT a global partial
+		if (!isGlobalPartial) {
+			processor.use(transformExcludeContent, {
+				filePath,
+				version,
+				repoSlug: entry.repoSlug,
+				productConfig: PRODUCT_CONFIG[entry.repoSlug],
+			})
+		}
+
+		const remarkResults = await processor
 			.use(paragraphCustomAlertsPlugin)
 			.use(rewriteInternalRedirectsPlugin, {
 				redirects,

scripts/prebuild/mdx-transforms/build-mdx-transforms.mjs

@@ -23,7 +23,8 @@ import {
 	rewriteInternalRedirectsPlugin,
 	loadRedirects,
 } from './rewrite-internal-redirects/rewrite-internal-redirects.mjs'
-import { transformExcludeTerraformContent } from './exclude-terraform-content/index.mjs'
+
+import { transformExcludeContent } from './exclude-content/index.mjs'
 
 import { PRODUCT_CONFIG } from '#productConfig.mjs'
 
@@ -78,11 +79,9 @@ export async function buildMdxTransforms(
 		)
 		const redirectsDir = path.join(targetDir, repoSlug, verifiedVersion)
 		const outPath = path.join(outputDir, relativePath)
-		return { filePath, partialsDir, outPath, version, redirectsDir }
+		return { repoSlug, filePath, partialsDir, outPath, version, redirectsDir }
 	})
-	/**
-	 * Apply MDX transforms to each file entry, in batches
-	 */
+
 	console.log(`Running MDX transforms on ${mdxFileEntries.length} files...`)
 	const results = await batchPromises(
 		'MDX transforms',
@@ -132,10 +131,28 @@ async function applyMdxTransforms(entry, versionMetadata = {}) {
 		const fileString = fs.readFileSync(filePath, 'utf8')
 		const { data, content } = grayMatter(fileString)
 
-		const remarkResults = await remark()
+		// Check if this file is in a global/partials directory
+		// Global partials should not have content exclusion applied to them
+		// as they are version-agnostic and shared across all versions
+		const isGlobalPartial = filePath.includes('/global/partials/')
+
+		const processor = remark()
 			.use(remarkMdx)
-			.use(transformExcludeTerraformContent, { filePath })
+			// Process partials first, then content exclusion
+			// This ensures exclusion directives in global partials are properly evaluated
 			.use(remarkIncludePartialsPlugin, { partialsDir, filePath })
+
+		// Only apply content exclusion if this is NOT a global partial
+		if (!isGlobalPartial) {
+			processor.use(transformExcludeContent, {
+				filePath,
+				version,
+				repoSlug: entry.repoSlug,
+				productConfig: PRODUCT_CONFIG[entry.repoSlug],
+			})
+		}
+
+		const remarkResults = await processor
 			.use(paragraphCustomAlertsPlugin)
 			.use(rewriteInternalRedirectsPlugin, {
 				redirects,