[docs] Rename PluginFileSummary to ComponentFileSummary

moodle · Apr 28, 2022 · 1274a16 · 1274a16
1 parent 4491bb0
commit 1274a16
Show file tree

Hide file tree

Showing 34 changed files with 99 additions and 99 deletions.
diff --git a/docs/_utils.tsx b/docs/_utils.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary as PluginFileSummaryGeneric } from '@site/src/components';
+import { ComponentFileSummary as ComponentFileSummaryGeneric } from '@site/src/components';
 import { getExample } from '@site/src/moodleBridge';
 
 import type { Props } from '@site/src/moodleBridge';
@@ -63,7 +63,7 @@ export const getDescription = ({
     );
 };
 
-export const PluginFileSummary = (initialProps: Props): ReactFragment => {
+export const ComponentFileSummary = (initialProps: Props): ReactFragment => {
     const props = fillDefaultProps({
         examplePurpose: initialProps?.summary ?? null,
         ...initialProps,
@@ -75,5 +75,5 @@ export const PluginFileSummary = (initialProps: Props): ReactFragment => {
         props.example = getExample(props, props?.defaultExample ?? null);
     }
 
-    return PluginFileSummaryGeneric(props);
+    return ComponentFileSummaryGeneric(props);
 };
diff --git a/docs/apis/_files/amd-dir.tsx b/docs/apis/_files/amd-dir.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './amd-dir.mdx';
 
@@ -27,8 +27,8 @@ export const updateThings = (thingData) => {
 };
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         required
         defaultDescription={DefaultDescription}
         defaultExample={defaultExample}

diff --git a/docs/apis/_files/backup-dir.tsx b/docs/apis/_files/backup-dir.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './backup-dir.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/backup/"
         summary="Plugin Backup configuration"
         defaultDescription={DefaultDescription}

diff --git a/docs/apis/_files/changes.tsx b/docs/apis/_files/changes.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './changes.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/CHANGES"
         filetype="php"
         summary="Plugin changelog"

diff --git a/docs/apis/_files/classes-dir.tsx b/docs/apis/_files/classes-dir.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './classes-dir.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/classes/"
         summary="Autoloaded classes"
         defaultDescription={DefaultDescription}

diff --git a/docs/apis/_files/cli-dir.tsx b/docs/apis/_files/cli-dir.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './cli-dir.mdx';
 
@@ -27,8 +27,8 @@ require_once("{$CFG->libdir}/clilib.php");
 // Your CLI features go here.
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/cli/"
         summary="CLI scripts"
         exampleFilepath="/cli/example.php"

diff --git a/docs/apis/_files/db-access-php.tsx b/docs/apis/_files/db-access-php.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-access-php.mdx';
 
@@ -33,8 +33,8 @@ const defaultExample = `$capabilities = [
 ];
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         defaultDescription={DefaultDescription}
         defaultExample={defaultExample}
         filepath="/db/access.php"

diff --git a/docs/apis/_files/db-events-php.tsx b/docs/apis/_files/db-events-php.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-events-php.mdx';
 
@@ -28,8 +28,8 @@ const defaultExample = `$observers = [
 ];
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         refreshedDuringUpgrade
         defaultDescription={DefaultDescription}
         defaultExample={defaultExample}

diff --git a/docs/apis/_files/db-install-php.tsx b/docs/apis/_files/db-install-php.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-install-php.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         defaultDescription={DefaultDescription}
         filepath="/CHANGES"
         filetype="php"

diff --git a/docs/apis/_files/db-messages-php.tsx b/docs/apis/_files/db-messages-php.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-messages-php.mdx';
 
@@ -29,8 +29,8 @@ $messageproviders = [
 ];
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         refreshedDuringUpgrade
         defaultExample={defaultExample}
         defaultDescription={DefaultDescription}

diff --git a/docs/apis/_files/db-mobile-php.tsx b/docs/apis/_files/db-mobile-php.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-mobile-php.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         refreshedDuringUpgrade
         defaultDescription={DefaultDescription}
         filepath="/db/mobile.php"

diff --git a/docs/apis/_files/db-renamedclasses-php.tsx b/docs/apis/_files/db-renamedclasses-php.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-renamedclasses-php.mdx';
 
@@ -36,8 +36,8 @@ $renamedclasses = [
 ];
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         refreshedDuringPurge
         defaultExample={defaultExample}
         defaultDescription={DefaultDescription}

diff --git a/docs/apis/_files/db-services-php.tsx b/docs/apis/_files/db-services-php.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-services-php.mdx';
 
@@ -35,8 +35,8 @@ $functions = [
 ];
 `;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         refreshedDuringUpgrade
         recommended
         filepath="/db/services.php"

diff --git a/docs/apis/_files/db-uninstall-php.tsx b/docs/apis/_files/db-uninstall-php.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-uninstall-php.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         defaultDescription={DefaultDescription}
         filepath="/db/uninstall.php"
         filetype="php"

diff --git a/docs/apis/_files/db-upgrade-php.tsx b/docs/apis/_files/db-upgrade-php.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-upgrade-php.mdx';
 
@@ -42,8 +42,8 @@ function xmldb_certificate_upgrade($oldversion = 0) {
     }
 }`;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         recommended
         defaultDescription={DefaultDescription}
         defaultExample={defaultExample}

diff --git a/docs/apis/_files/environment-xml.tsx b/docs/apis/_files/environment-xml.tsx
@@ -15,7 +15,7 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './environment-xml.mdx';
 
@@ -30,8 +30,8 @@ const defaultExample = `
   </PLUGIN>
 </COMPATIBILITY_MATRIX>`;
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         showFileHeader={false}
         showLicense={false}
         refreshedDuringUpgrade

diff --git a/docs/apis/_files/install-xml.tsx b/docs/apis/_files/install-xml.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './db-install-xml.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/db/install.xml"
         summary="Database schema"
         examplePurpose="Database schema"

diff --git a/docs/apis/_files/lang.tsx b/docs/apis/_files/lang.tsx
@@ -15,14 +15,14 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './lang.mdx';
 
 const defaultExample = "$string['pluginname'] = 'The name of my plugin will go here';";
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/lang/en/plugintype_pluginname.php"
         refreshedDuringPurge
         required

diff --git a/docs/apis/_files/lib.tsx b/docs/apis/_files/lib.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './lib.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         legacy
         required={false}
         filepath="/lib.php"

diff --git a/docs/apis/_files/locallib.tsx b/docs/apis/_files/locallib.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './locallib.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         defaultDescription={DefaultDescription}
         filepath="/locallib.php"
         legacy

diff --git a/docs/apis/_files/pix-dir.tsx b/docs/apis/_files/pix-dir.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './pix-dir.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         defaultDescription={DefaultDescription}
         refreshedDuringPurge
         filepath="/pix/"

diff --git a/docs/apis/_files/readme.tsx b/docs/apis/_files/readme.tsx
@@ -15,12 +15,12 @@
  * along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  */
 import React from 'react';
-import { PluginFileSummary } from '../../_utils';
+import { ComponentFileSummary } from '../../_utils';
 import type { Props } from '../../_utils';
 import DefaultDescription from './readme.mdx';
 
-export default (initialProps: Props): PluginFileSummary => (
-    <PluginFileSummary
+export default (initialProps: Props): ComponentFileSummary => (
+    <ComponentFileSummary
         filepath="/README"
         recommended
         defaultDescription={DefaultDescription}