Merge pull request #47 from boazpoolman/release/stable

Release/stable

Author: boazpoolman

README.md

@@ -66,7 +66,17 @@ npm run build
 npm run develop
 ```
 
-The **Config Sync** plugin should appear in the **Plugins** section of Strapi sidebar after you run app again.
+The **Config Sync** plugin should now appear in the **Settings** section of your Strapi app.
+
+To start tracking your config changes you have to make the first export. This will dump all your configuration data to the `/config/sync` directory. To export, run:
+
+```bash
+# using yarn
+yarn config-sync export
+
+# using npm
+npm run config-sync export
+```
 
 Enjoy 🎉
 
@@ -76,7 +86,7 @@ Complete installation requirements are the exact same as for Strapi itself and c
 
 **Supported Strapi versions**:
 
-- Strapi 4.0.7 (recently tested)
+- Strapi 4.1.5 (recently tested)
 - Strapi ^4.x (use `strapi-plugin-config-sync@^1.0.0`)
 - Strapi ^3.4.x (use `[email protected]`)
 

admin/src/components/ConfigDiff/index.js

@@ -2,7 +2,6 @@ import React from 'react';
 import ReactDiffViewer, { DiffMethod } from 'react-diff-viewer';
 
 import { ModalLayout, ModalBody, ModalHeader } from '@strapi/design-system/ModalLayout';
-import { ButtonText } from '@strapi/design-system/Text';
 import { Grid, GridItem } from '@strapi/design-system/Grid';
 import { Typography } from '@strapi/design-system/Typography';
 
@@ -17,9 +16,9 @@ const ConfigDiff = ({ isOpen, onClose, oldValue, newValue, configName }) => {
       labelledBy="title"
     >
       <ModalHeader>
-        <ButtonText textColor="neutral800" as="h2" id="title">
+        <Typography variant="omega" fontWeight="bold" textColor="neutral800">
           Config changes for {configName}
-        </ButtonText>
+        </Typography>
       </ModalHeader>
       <ModalBody>
         <Grid paddingBottom={4} style={{ textAlign: 'center' }}>

admin/src/components/ConfigList/index.js

@@ -3,7 +3,7 @@ import { isEmpty } from 'lodash';
 import { useDispatch } from 'react-redux';
 
 import { Table, Thead, Tbody, Tr, Th } from '@strapi/design-system/Table';
-import { TableLabel } from '@strapi/design-system/Text';
+import { Typography } from '@strapi/design-system/Typography';
 import { BaseCheckbox } from '@strapi/design-system/BaseCheckbox';
 import { Loader } from '@strapi/design-system/Loader';
 
@@ -127,13 +127,13 @@ const ConfigList = ({ diff, isLoading }) => {
               />
             </Th>
             <Th>
-              <TableLabel>Config name</TableLabel>
+              <Typography variant="sigma">Config name</Typography>
             </Th>
             <Th>
-              <TableLabel>Config type</TableLabel>
+              <Typography variant="sigma">Config type</Typography>
             </Th>
             <Th>
-              <TableLabel>State</TableLabel>
+              <Typography variant="sigma">State</Typography>
             </Th>
           </Tr>
         </Thead>

admin/src/components/ConfirmModal/index.js

@@ -3,7 +3,7 @@ import { useIntl } from 'react-intl';
 
 import { Dialog, DialogBody, DialogFooter } from '@strapi/design-system/Dialog';
 import { Flex } from '@strapi/design-system/Flex';
-import { Text } from '@strapi/design-system/Text';
+import { Typography } from '@strapi/design-system/Typography';
 import { Stack } from '@strapi/design-system/Stack';
 import { Button } from '@strapi/design-system/Button';
 import ExclamationMarkCircle from '@strapi/icons/ExclamationMarkCircle';
@@ -22,10 +22,10 @@ const ConfirmModal = ({ isOpen, onClose, onSubmit, type }) => {
       <DialogBody icon={<ExclamationMarkCircle />}>
         <Stack size={2}>
           <Flex justifyContent="center">
-            <Text id="confirm-description" style={{ textAlign: 'center' }}>
+            <Typography variant="omega" id="confirm-description" style={{ textAlign: 'center' }}>
               {formatMessage({ id: `config-sync.popUpWarning.warning.${type}_1` })}<br />
               {formatMessage({ id: `config-sync.popUpWarning.warning.${type}_2` })}
-            </Text>
+            </Typography>
           </Flex>
         </Stack>
       </DialogBody>

admin/src/containers/ConfigPage/index.js

@@ -2,6 +2,7 @@ import React, { useEffect } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import { Map } from 'immutable';
 import { Box } from '@strapi/design-system/Box';
+import { ContentLayout } from '@strapi/design-system/Layout';
 import { useNotification } from '@strapi/helper-plugin';
 import { Alert } from '@strapi/design-system/Alert';
 import { Typography } from '@strapi/design-system/Typography';
@@ -23,7 +24,7 @@ const ConfigPage = () => {
   }, []);
 
   return (
-    <Box paddingLeft={8} paddingRight={8} paddingBottom={8}>
+    <ContentLayout paddingBottom={8}>
       {appEnv === 'production' && (
         <Box paddingBottom={4}>
           <Alert variant="danger">
@@ -35,7 +36,7 @@ const ConfigPage = () => {
       )}
       <ActionButtons />
       <ConfigList isLoading={isLoading} diff={configDiff.toJS()} />
-    </Box>
+    </ContentLayout>
   );
 };
 

admin/src/index.js

@@ -1,8 +1,8 @@
 import { prefixPluginTranslations } from '@strapi/helper-plugin';
 import pluginPkg from '../../package.json';
 import pluginId from './helpers/pluginId';
-import pluginIcon from './components/PluginIcon';
 import pluginPermissions from './permissions';
+// import pluginIcon from './components/PluginIcon';
 // import getTrad from './helpers/getTrad';
 
 const pluginDescription = pluginPkg.strapi.description || pluginPkg.description;
@@ -18,22 +18,33 @@ export default {
       name,
     });
 
-    app.addMenuLink({
-      to: `/plugins/${pluginId}`,
-      icon: pluginIcon,
-      intlLabel: {
-        id: `${pluginId}.plugin.name`,
-        defaultMessage: 'Config Sync',
+    app.createSettingSection(
+      {
+        id: pluginId,
+        intlLabel: {
+          id: `${pluginId}.plugin.name`,
+          defaultMessage: 'Config Sync',
+        },
       },
-      Component: async () => {
-        const component = await import(
-          /* webpackChunkName: "config-sync-settings-page" */ './containers/App'
-        );
+      [
+        {
+          intlLabel: {
+            id: `${pluginId}.Settings.Tool.Title`,
+            defaultMessage: 'Tools',
+          },
+          id: 'config-sync-page',
+          to: `/settings/${pluginId}`,
+          Component: async () => {
+            const component = await import(
+              /* webpackChunkName: "config-sync-settings-page" */ './containers/App'
+            );
 
-        return component;
-      },
-      permissions: pluginPermissions['menu-link'],
-    });
+            return component;
+          },
+          permissions: pluginPermissions['settings'],
+        },
+      ],
+    );
   },
   bootstrap(app) {},
   async registerTrads({ locales }) {

admin/src/translations/en.json

@@ -10,5 +10,7 @@
   "Header.Title": "Config Sync",
   "Header.Description": "Manage your database config across environments.",
 
+  "Settings.Tool.Title": "Tool",
+
   "plugin.name": "Config Sync"
 }

package.json

@@ -1,12 +1,12 @@
 {
   "name": "strapi-plugin-config-sync",
   "version": "1.0.0-beta.8",
-  "description": "CLI & GUI for syncing config data across environments.",
+  "description": "Migrate your config data across environments using the CLI or Strapi admin panel.",
   "strapi": {
     "displayName": "Config Sync",
     "name": "config-sync",
     "icon": "sync",
-    "description": "CLI & GUI for syncing config data across environments.",
+    "description": "Migrate your config data across environments using the CLI or Strapi admin panel.",
     "required": false,
     "kind": "plugin"
   },
@@ -57,10 +57,10 @@
   },
   "devDependencies": {
     "@fortawesome/react-fontawesome": "^0.1.16",
-    "@strapi/design-system": "^0.0.1-alpha.75",
-    "@strapi/helper-plugin": "^4.0.7",
-    "@strapi/icons": "^0.0.1-alpha.75",
-    "@strapi/utils": "^4.0.7",
+    "@strapi/design-system": "^0.0.1-alpha.79",
+    "@strapi/helper-plugin": "^4.1.5",
+    "@strapi/icons": "^0.0.1-alpha.79",
+    "@strapi/utils": "^4.1.5",
     "babel-eslint": "9.0.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb": "^18.2.1",

playground/package.json

@@ -15,9 +15,9 @@
     "jest-cli": "^26.0.1"
   },
   "dependencies": {
-    "@strapi/plugin-i18n": "^4.0.2",
-    "@strapi/plugin-users-permissions": "^4.0.2",
-    "@strapi/strapi": "^4.0.2",
+    "@strapi/plugin-i18n": "^4.0.0",
+    "@strapi/plugin-users-permissions": "^4.0.0",
+    "@strapi/strapi": "^4.0.0",
     "sqlite3": "5.0.2",
     "strapi-plugin-config-sync": "boazpoolman/strapi-plugin-config-sync"
   },

server/cli.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+const fs = require('fs');
 const { Command } = require('commander');
 const Table = require('cli-table');
 const chalk = require('chalk');
@@ -68,6 +69,14 @@ const getConfigState = (diff, configName, syncType) => {
 
 const handleAction = async (syncType, skipConfirm, configType, partials) => {
   const app = await strapi().load();
+  const hasSyncDir = fs.existsSync(app.config.get('plugin.config-sync.syncDir'));
+
+  // No import with empty sync dir.
+  if (!hasSyncDir && syncType === 'import') {
+    console.log(`${chalk.yellow.bold('[warning]')} You can't import an empty sync directory. Please export before continuing.`);
+    process.exit(0);
+  }
+
   const diff = await app.plugin('config-sync').service('main').getFormattedDiff();
 
   // No changes.
@@ -109,7 +118,9 @@ const handleAction = async (syncType, skipConfirm, configType, partials) => {
   });
 
   // Print table.
-  console.log(table.toString(), '\n');
+  if (hasSyncDir) {
+    console.log(table.toString(), '\n');
+  }
 
   // Prompt to confirm.
   let answer = {};