chore: add docgen-ignore (react-native-elements#3675)

Author: arpitBhalla

packages/base/.docgenignore

@@ -0,0 +1,6 @@
+**/index.tsx
+src/*/components/**
+**/__tests__/**
+**/helpers/**
+**/config/**
+src/SearchBar/SearchBar-**

packages/themed/.docgenignore

@@ -0,0 +1 @@
+**

scripts/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "no-console": "off",
+    "no-unused-vars": "off"
+  }
+}

scripts/docgen/README.md

@@ -0,0 +1,20 @@
+# RNE DocGen
+
+```bash
+
+yarn docs-build-api
+
+```
+
+## Options
+
+```bash
+yarn docs-build-api --source='base/src/Avatar/**'
+yarn docs-build-api -s='base/src/Avatar/**'
+
+## or
+
+yarn docs-build-api --component='Button' --pkg='base'
+yarn docs-build-api -c='Button' -p='base'
+
+```

scripts/docgen/index.ts

@@ -3,30 +3,19 @@ import path from 'path';
 import { Markdown } from './generateMarkdown';
 import { separateParent } from './parentProps';
 import { docgenParser } from './docgenParser';
+import { findIgnoredComponents } from './utils';
 import yargs from 'yargs';
 
 const rootPath = path.join(__dirname, '../../packages/');
 
-const ignore = [
-  // Ignore themed package
-  rootPath + 'themed/**',
-  '**/base/**/index.tsx',
-  '**/src/*/components/**',
-  '**/__tests__/**',
-  '**/helpers/**',
-  '**/config/**',
-  '**/base/src/SearchBar/SearchBar-**',
-];
-
-function main(sourcePath: string) {
-  const filePaths = glob.sync(
-    path.join(rootPath, sourcePath || '*/src/**/*.tsx'),
-    {
-      absolute: true,
-      ignore,
-      onlyFiles: true,
-    }
-  );
+function main({ source = '*/src/**/*.tsx' }: typeof argv) {
+  const ignoredFiles = findIgnoredComponents(rootPath);
+
+  const filePaths = glob.sync(path.join(rootPath, source), {
+    absolute: true,
+    ignore: ignoredFiles,
+    onlyFiles: true,
+  });
 
   console.log('Found', filePaths.length, 'components');
 
@@ -39,8 +28,10 @@ function main(sourcePath: string) {
   });
 }
 
-const argv = yargs(process.argv.slice(2)).options({
-  include: { type: 'string', alias: 'i' },
-}).argv;
+const { argv } = yargs(process.argv.slice(2)).options({
+  source: { type: 'string', alias: 's' },
+  component: { type: 'string', alias: 'c' },
+  pkg: { type: 'string', alias: 'p' },
+});
 
-main(argv.include);
+main(argv);

scripts/docgen/utils.ts

@@ -1,5 +1,8 @@
 import { transform, types as t } from '@babel/core';
 import dedent from 'dedent';
+import glob from 'fast-glob';
+import { join, dirname } from 'path';
+import fs from 'fs';
 
 export const tabify = (str: string) => {
   return transform(`<>\n${str}\n</>`, {
@@ -99,3 +102,22 @@ export const filterPropType = (value: string) => {
   }
   return value;
 };
+
+export function findIgnoredComponents(rootPath: string) {
+  const docgenIgnoreFiles = glob.sync(join(rootPath, '**/.docgenignore'), {
+    absolute: true,
+    onlyFiles: true,
+  });
+  const ignoredFiles = [];
+  docgenIgnoreFiles.forEach((filePath) => {
+    const content = fs.readFileSync(filePath, 'utf-8').trim();
+    content.split('\n').forEach((componentPath) => {
+      const trimmedPath = componentPath.trim();
+      if (trimmedPath) {
+        ignoredFiles.push(join(dirname(filePath), trimmedPath));
+      }
+    });
+  });
+
+  return ignoredFiles;
+}

scripts/release/index.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import path from 'path';
 import fs from 'fs';
 import semver from 'semver';