Prevent exposure of sensitive or unnecessary data in example code

yorkie-team · Aug 22, 2024 · f95b9fa · f95b9fa
1 parent d96d3bb
commit f95b9fa
Show file tree

Hide file tree

Showing 18 changed files with 28 additions and 41 deletions.
diff --git a/components/exampleView/BasicView/commonIgnoreFiles.ts b/components/exampleView/BasicView/commonIgnoreFiles.ts
@@ -2,6 +2,13 @@ export const COMMON_IGNORE_FILES = [
   '*.ico',
   'README.md',
   'package-lock.json',
-  'tsconfig.json',
   '.gitignore',
+  'thumbnail.jpg',
+  '.env.production',
+  '.eslintrc.js',
+  'tsconfig.json',
+  'tsconfig.node.json',
+  'vite.config.js',
+  'vite.config.ts',
+  'vite-env.d.ts',
 ];
diff --git a/examples/nextjs-scheduler/fileInfo.ts b/examples/nextjs-scheduler/fileInfo.ts
diff --git a/examples/profile-stack/fileInfo.ts b/examples/profile-stack/fileInfo.ts
diff --git a/examples/react-tldraw/fileInfo.ts b/examples/react-tldraw/fileInfo.ts
diff --git a/examples/react-todomvc/fileInfo.ts b/examples/react-todomvc/fileInfo.ts
diff --git a/examples/simultaneous-cursors/fileInfo.ts b/examples/simultaneous-cursors/fileInfo.ts
diff --git a/examples/vanilla-codemirror6/fileInfo.ts b/examples/vanilla-codemirror6/fileInfo.ts
diff --git a/examples/vanilla-quill/fileInfo.ts b/examples/vanilla-quill/fileInfo.ts
diff --git a/examples/vuejs-kanban/fileInfo.ts b/examples/vuejs-kanban/fileInfo.ts
diff --git a/pages/examples/calendar.tsx b/pages/examples/calendar.tsx
@@ -45,7 +45,7 @@ const CalendarExampleView: NextPage = () => {
                 <ProjectCodes
                   files={FILE_INFO}
                   activeFile="/app/page.tsx"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env', 'vite.config.js', '/src/vite-env.d.ts']}
+                  ignoreFiles={[...COMMON_IGNORE_FILES, 'next.config.js']}
                 />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />

diff --git a/pages/examples/codemirror.tsx b/pages/examples/codemirror.tsx
@@ -41,11 +41,7 @@ const CodemirrorExampleView: NextPage = () => {
                   </a>
                   , a custom CRDT type from Yorkie.
                 </Sidebar.GuideDescription>
-                <ProjectCodes
-                  files={FILE_INFO}
-                  activeFile="/src/main.ts"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env', 'vite.config.js', '/src/vite-env.d.ts']}
-                />
+                <ProjectCodes files={FILE_INFO} activeFile="/src/main.ts" ignoreFiles={COMMON_IGNORE_FILES} />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />
             </Sidebar.Tabs>

diff --git a/pages/examples/kanban.tsx b/pages/examples/kanban.tsx
@@ -39,11 +39,7 @@ const KanbanExampleView: NextPage = () => {
                   Kanban Board is a tool for managing tasks and workflow. It is a visual way to manage tasks and
                   workflow.
                 </Sidebar.GuideDescription>
-                <ProjectCodes
-                  files={FILE_INFO}
-                  activeFile="/src/App.vue"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env']}
-                />
+                <ProjectCodes files={FILE_INFO} activeFile="/src/App.vue" ignoreFiles={COMMON_IGNORE_FILES} />
               </Sidebar.TabsPanel>
               <Sidebar.TabsPanel value="documentStructure">
                 <div className="codeblock_box">

diff --git a/pages/examples/profile-stack.tsx b/pages/examples/profile-stack.tsx
@@ -34,11 +34,7 @@ const ProfileStackExampleView: NextPage = () => {
                   The profile stack shows the list of users currently accessing the Document. Try adding and deleting
                   users to see how the profile stack changes.
                 </Sidebar.GuideDescription>
-                <ProjectCodes
-                  files={FILE_INFO}
-                  activeFile="/main.js"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env', 'vite.config.js']}
-                />
+                <ProjectCodes files={FILE_INFO} activeFile="/main.js" ignoreFiles={COMMON_IGNORE_FILES} />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />
             </Sidebar.Tabs>

diff --git a/pages/examples/quill.tsx b/pages/examples/quill.tsx
@@ -46,11 +46,7 @@ const QuillExampleView: NextPage = () => {
                   </a>
                   .
                 </Sidebar.GuideDescription>
-                <ProjectCodes
-                  files={FILE_INFO}
-                  activeFile="/src/main.ts"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env', 'vite.config.js', '/src/vite-env.d.ts']}
-                />
+                <ProjectCodes files={FILE_INFO} activeFile="/src/main.ts" ignoreFiles={COMMON_IGNORE_FILES} />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />
             </Sidebar.Tabs>

diff --git a/pages/examples/simultaneous-cursors.tsx b/pages/examples/simultaneous-cursors.tsx
@@ -47,11 +47,7 @@ const SimultaneousExampleView: NextPage = () => {
                   </a>
                   .
                 </Sidebar.GuideDescription>
-                <ProjectCodes
-                  files={FILE_INFO}
-                  activeFile="/src/App.jsx"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env']}
-                />
+                <ProjectCodes files={FILE_INFO} activeFile="/src/App.jsx" ignoreFiles={COMMON_IGNORE_FILES} />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />
             </Sidebar.Tabs>

diff --git a/pages/examples/tldraw.tsx b/pages/examples/tldraw.tsx
@@ -58,7 +58,7 @@ const TldrawExampleView: NextPage = () => {
                 <ProjectCodes
                   files={FILE_INFO}
                   activeFile="/src/hooks/useMultiplayerState.ts"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env', 'vite.config.js']}
+                  ignoreFiles={COMMON_IGNORE_FILES}
                 />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />

diff --git a/pages/examples/todomvc.tsx b/pages/examples/todomvc.tsx
@@ -55,11 +55,7 @@ const TodoListExampleView: NextPage = () => {
                   </a>
                   .
                 </Sidebar.GuideDescription>
-                <ProjectCodes
-                  files={FILE_INFO}
-                  activeFile="/src/App.tsx"
-                  ignoreFiles={[...COMMON_IGNORE_FILES, '.env', '/src/vite-env.d.ts', 'tsconfig.node.json']}
-                />
+                <ProjectCodes files={FILE_INFO} activeFile="/src/App.tsx" ignoreFiles={COMMON_IGNORE_FILES} />
               </Sidebar.TabsPanel>
               <Sidebar.Bottom codeURL={EXAMPLE_CODE_URL + exampleKey} />
             </Sidebar.Tabs>

diff --git a/scripts/fetchExamples.mts b/scripts/fetchExamples.mts
@@ -68,6 +68,10 @@ const getFileLanguage = (filename: string): string => {
 };
 
 const getFileContent = (filePath: string): string => {
+  if (filePath.includes('.env.production')) {
+    return '';
+  }
+
   const extension = getFileExtension(filePath);
   // NOTE(chacha912): Image file is not supported.
   if (extension === 'ico' || extension === 'png' || extension === 'jpg') {