bito-code-review[bot] commented on code in PR #37404: URL: https://github.com/apache/superset/pull/37404#discussion_r2729985037
########## docs/plugins/remark-tech-article-schema.mjs: ########## @@ -0,0 +1,161 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// Note: visit from unist-util-visit is available if needed for tree traversal + +/** + * Remark plugin that automatically injects TechArticle schema import and component + * into documentation MDX files based on frontmatter. + * + * This enables rich snippets for technical documentation in search results. + * + * Frontmatter options: + * - title: (required) Article headline + * - description: (required) Article description + * - keywords: (optional) Array of keywords + * - seo_proficiency: (optional) 'Beginner' or 'Expert', defaults to 'Beginner' + * - seo_schema: (optional) Set to false to disable schema injection + */ +export default function remarkTechArticleSchema() { + return (tree, file) => { + const frontmatter = file.data.frontMatter || {}; + + // Skip if explicitly disabled or missing required fields + if (frontmatter.seo_schema === false) { + return; + } + + // Only add schema if we have title and description + if (!frontmatter.title || !frontmatter.description) { + return; + } + + const title = frontmatter.title; + const description = frontmatter.description; + const keywords = frontmatter.keywords || []; Review Comment: <div> <div id="suggestion"> <div id="issue"><b>Input validation</b></div> <div id="fix"> If frontmatter.keywords is not an array, keywords.map() will throw a TypeError; add Array.isArray check. </div> <details> <summary> <b>Code suggestion</b> </summary> <blockquote>Check the AI-generated fix before applying</blockquote> <div id="code"> ````suggestion const keywords = Array.isArray(frontmatter.keywords) ? frontmatter.keywords : []; ```` </div> </details> </div> <small><i>Code Review Run #6b08fd</i></small> </div> --- Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>) - [ ] Yes, avoid them -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
