ambiser
/
strapi-plugin-config-sync
mirror of https://github.com/boazpoolman/strapi-plugin-config-sync
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactor: use pack-up for bundling

pull/153/head
Boaz Poolman 2024-11-06 11:59:15 +01:00
parent 203fb4e7d1
commit cc0e71988a
26 changed files with 730 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored
View File

@ -9,3 +9,8 @@ files
.DS_Store
npm-debug.log
.idea
# Production build
build
dist
bundle

30
admin/src/index.js
View File

@ -49,21 +49,21 @@ export default {
bootstrap(app) {},
async registerTrads({ locales }) {
const importedTrads = await Promise.all(
locales.map(async (locale) => {
try {
// eslint-disable-next-line import/no-dynamic-require, global-require
const data = require(`./translations/${locale}.json`);
return {
data: prefixPluginTranslations(data, pluginId),
locale,
};
} catch {
return {
data: {},
locale,
};
}
}),
locales.map((locale) => {
return import(`./translations/${locale}.json`)
.then(({ default: data }) => {
return {
data: prefixPluginTranslations(data, pluginId),
locale,
};
})
.catch(() => {
return {
data: {},
locale,
};
});
})
);
return Promise.resolve(importedTrads);

2
bin/config-sync
View File

@ -2,4 +2,4 @@
'use strict';
require('../server/cli');
require('../dist/cli');

34
package.json
View File

@ -13,9 +13,25 @@
"bin": {
"config-sync": "./bin/config-sync"
},
"exports": {
"./strapi-admin": {
"source": "./admin/src/index.js",
"import": "./dist/admin/index.mjs",
"require": "./dist/admin/index.js",
"default": "./dist/admin/index.js"
},
"./strapi-server": {
"source": "./server/index.js",
"import": "./dist/server/index.mjs",
"require": "./dist/server/index.js",
"default": "./dist/server/index.js"
},
"./package.json": "./package.json"
},
"scripts": {
"develop": "nodemon -e js,jsx --ignore playground --exec \"yalc publish && yalc push\"",
"build": "yalc push --publish",
"develop": "strapi-plugin watch:link",
"watch": "pack-up watch",
"build": "pack-up build && yalc push --publish",
"eslint": "eslint --max-warnings=0 './**/*.{js,jsx}'",
"eslint:fix": "eslint --fix './**/*.{js,jsx}'",
"test:unit": "jest --verbose",
@ -52,18 +68,20 @@
}
],
"files": [
"admin",
"server",
"bin",
"strapi-admin.js",
"strapi-server.js"
"dist",
"bin"
],
"peerDependencies": {
"@strapi/strapi": "^5.0.0"
"@strapi/strapi": "^5.0.0",
"react": "^17.0.0 || ^18.0.0",
"react-dom": "^17.0.0 || ^18.0.0",
"react-router-dom": "^5.2.0",
"styled-components": "^5.2.1"
},
"devDependencies": {
"@strapi/design-system": "2.0.0-rc.11",
"@strapi/icons": "2.0.0-rc.11",
"@strapi/sdk-plugin": "^5.2.7",
"@strapi/strapi": "5.0.4",
"@strapi/utils": "5.0.4",
"babel-eslint": "9.0.0",

27
packup.config.ts Normal file
View File

@ -0,0 +1,27 @@
// eslint-disable-next-line import/no-extraneous-dependencies
import { defineConfig } from '@strapi/pack-up';
export default defineConfig({
bundles: [
{
source: './admin/src/index.js',
import: './dist/admin/index.mjs',
require: './dist/admin/index.js',
runtime: 'web',
},
{
source: './server/index.js',
import: './dist/server/index.mjs',
require: './dist/server/index.js',
runtime: 'node',
},
{
source: './server/cli.js',
import: './dist/cli/index.mjs',
require: './dist/cli/index.js',
runtime: 'node',
},
],
dist: './dist',
exports: {},
});

10
server/bootstrap.js
View File

@ -1,10 +1,10 @@
'use strict';
const fs = require('fs');
import fs from 'fs';
const ConfigType = require('./config/type');
const defaultTypes = require('./config/types');
const { logMessage } = require('./utils');
import ConfigType from './config/type';
import defaultTypes from './config/types';
import { logMessage } from './utils';
/**
* An asynchronous bootstrap function that runs before
@ -16,7 +16,7 @@ const { logMessage } = require('./utils');
* See more details here: https://strapi.io/documentation/v3.x/concepts/configurations.html#bootstrap
*/
module.exports = async () => {
export default async () => {
// Register config types.
const registerTypes = () => {
const types = {};

20
server/cli.js
View File

@ -1,16 +1,16 @@
#!/usr/bin/env node
const fs = require('fs');
const { Command } = require('commander');
const Table = require('cli-table');
const chalk = require('chalk');
const inquirer = require('inquirer');
const { isEmpty } = require('lodash');
const { createStrapi, compileStrapi } = require('@strapi/strapi');
const gitDiff = require('git-diff');
import fs from 'fs';
import { Command } from 'commander';
import Table from 'cli-table';
import chalk from 'chalk';
import inquirer from 'inquirer';
import { isEmpty } from 'lodash';
import { createStrapi, compileStrapi } from '@strapi/strapi';
import gitDiff from 'git-diff';
const warnings = require('./warnings');
const packageJSON = require('../package.json');
import warnings from './warnings';
import packageJSON from '../package.json';
const program = new Command();

2
server/config.js
View File

@ -1,6 +1,6 @@
'use strict';
module.exports = {
export default {
default: {
syncDir: "config/sync/",
minify: false,

10
server/config/type.js
View File

@ -1,7 +1,7 @@
const { isEmpty } = require('lodash');
const { logMessage, sanitizeConfig, dynamicSort, noLimit, getCombinedUid, getCombinedUidWhereFilter, getUidParamsFromName } = require('../utils');
const { difference, same } = require('../utils/getArrayDiff');
const queryFallBack = require('../utils/queryFallBack');
import { isEmpty } from 'lodash';
import { logMessage, sanitizeConfig, dynamicSort, noLimit, getCombinedUid, getCombinedUidWhereFilter, getUidParamsFromName } from '../utils';
import { difference, same } from '../utils/getArrayDiff';
import queryFallBack from '../utils/queryFallBack';
const ConfigType = class ConfigType {
constructor({ queryString, configName, uid, jsonFields, relations, components }) {
@ -270,4 +270,4 @@ const ConfigType = class ConfigType {
}
};
module.exports = ConfigType;
export default ConfigType;

2
server/config/types.js
View File

@ -49,4 +49,4 @@ const types = (strapi) => {
return typesArray;
};
module.exports = types;
export default types;

6
server/controllers/config.js
View File

@ -1,13 +1,13 @@
'use strict';
const fs = require('fs');
const { isEmpty } = require('lodash');
import fs from 'fs';
import { isEmpty } from 'lodash';
/**
* Main controllers for config import/export.
*/
module.exports = {
export default {
/**
* Export all config, from db to filesystem.
*

4
server/controllers/index.js
View File

@ -1,7 +1,7 @@
'use strict';
const config = require('./config');
import config from './config';
module.exports = {
export default {
config: config,
};

17
server/index.js Normal file
View File

@ -0,0 +1,17 @@
'use strict';
import register from './register';
import bootstrap from './bootstrap';
import services from './services';
import routes from './routes';
import config from './config';
import controllers from './controllers';
export default {
register,
bootstrap,
routes,
config,
controllers,
services,
};

2
server/register.js
View File

@ -1,6 +1,6 @@
'use strict';
module.exports = async ({ strapi }) => {
export default async ({ strapi }) => {
// Instantiate the pluginTypes array.
if (!strapi.plugin('config-sync').pluginTypes) {
strapi.plugin('config-sync').pluginTypes = [];

2
server/routes/admin.js
View File

@ -1,6 +1,6 @@
'use strict';
module.exports = {
export default {
type: 'admin',
routes: [
{

4
server/routes/index.js
View File

@ -1,7 +1,7 @@
'use strict';
const adminRoutes = require('./admin');
import adminRoutes from './admin';
module.exports = {
export default {
admin: adminRoutes,
};

4
server/services/index.js
View File

@ -1,7 +1,7 @@
'use strict';
const main = require('./main');
import main from './main';
module.exports = {
export default {
main,
};

14
server/services/main.js
View File

@ -1,17 +1,17 @@
'use strict';
const { isEmpty } = require('lodash');
const fs = require('fs');
const util = require('util');
const childProcess = require("child_process");
const difference = require('../utils/getObjectDiff');
const { logMessage } = require('../utils');
import { isEmpty } from 'lodash';
import fs from 'fs';
import util from 'util';
import childProcess from "child_process";
import difference from '../utils/getObjectDiff';
import { logMessage } from '../utils';
/**
* Main services for config import/export.
*/
module.exports = () => ({
export default () => ({
/**
* Write a single config file.
*

9
server/utils/getArrayDiff.js
View File

@ -1,4 +1,4 @@
const difference = (arrayOne, arrayTwo, compareKeys) => {
export const difference = (arrayOne, arrayTwo, compareKeys) => {
return arrayOne.filter(({
[compareKeys[0]]: id1,
[compareKeys[1]]: id2,
@ -10,7 +10,7 @@ const difference = (arrayOne, arrayTwo, compareKeys) => {
});
};
const same = (arrayOne, arrayTwo, compareKeys) => {
export const same = (arrayOne, arrayTwo, compareKeys) => {
return arrayOne.filter(({
[compareKeys[0]]: id1,
[compareKeys[1]]: id2,
@ -25,8 +25,3 @@ const same = (arrayOne, arrayTwo, compareKeys) => {
&& JSON.stringify(restOne) === JSON.stringify(restTwo));
});
};
module.exports = {
difference,
same,
};

4
server/utils/getObjectDiff.js
View File

@ -1,6 +1,6 @@
'use strict';
const { transform, isEqual, isArray, isObject } = require('lodash');
import { transform, isEqual, isArray, isObject } from 'lodash';
/**
* Find difference between two objects
@ -27,4 +27,4 @@ const difference = (origObj, newObj) => {
return Object.assign(newObjChange, origObjChange);
};
module.exports = difference;
export default difference;

31
server/utils/index.js
View File

@ -4,19 +4,19 @@ const COMBINED_UID_JOINSTR = '.combine-uid.';
const escapeUid = (uid) => typeof uid === "string" ? uid.replace(/\.combine-uid\./g, '.combine-uid-escape.') : uid;
const unEscapeUid = (uid) => typeof uid === "string" ? uid.replace(/\.combine-uid-escape\./g, '.combine-uid.') : uid;
const getCombinedUid = (uidKeys, params) => uidKeys.map((uidKey) => escapeUid(params[uidKey])).join(COMBINED_UID_JOINSTR);
const getCombinedUidWhereFilter = (uidKeys, params) => uidKeys.reduce(((akku, uidKey) => ({ ...akku, [uidKey]: params[uidKey] })), {});
const getUidParamsFromName = (uidKeys, configName) => configName.split(COMBINED_UID_JOINSTR).map(unEscapeUid).reduce((akku, param, i) => ({ ...akku, [uidKeys[i]]: param }), {});
export const getCombinedUid = (uidKeys, params) => uidKeys.map((uidKey) => escapeUid(params[uidKey])).join(COMBINED_UID_JOINSTR);
export const getCombinedUidWhereFilter = (uidKeys, params) => uidKeys.reduce(((akku, uidKey) => ({ ...akku, [uidKey]: params[uidKey] })), {});
export const getUidParamsFromName = (uidKeys, configName) => configName.split(COMBINED_UID_JOINSTR).map(unEscapeUid).reduce((akku, param, i) => ({ ...akku, [uidKeys[i]]: param }), {});
const getCoreStore = () => {
export const getCoreStore = () => {
return strapi.store({ type: 'plugin', name: 'config-sync' });
};
const getService = (name) => {
export const getService = (name) => {
return strapi.plugin('config-sync').service(name);
};
const logMessage = (msg = '') => `[strapi-plugin-config-sync]: ${msg}`;
export const logMessage = (msg = '') => `[strapi-plugin-config-sync]: ${msg}`;
const sortByKeys = (unordered) => {
return Object.keys(unordered).sort().reduce((obj, key) => {
@ -27,7 +27,7 @@ const sortByKeys = (unordered) => {
);
};
const dynamicSort = (property) => {
export const dynamicSort = (property) => {
let sortOrder = 1;
if (property[0] === "-") {
@ -46,7 +46,7 @@ const dynamicSort = (property) => {
};
};
const sanitizeConfig = ({
export const sanitizeConfig = ({
config,
relation,
relationSortFields,
@ -104,7 +104,7 @@ const sanitizeConfig = ({
return config;
};
const noLimit = async (query, parameters, limit = 100) => {
export const noLimit = async (query, parameters, limit = 100) => {
let entries = [];
const amountOfEntries = await query.count(parameters);
@ -121,16 +121,3 @@ const noLimit = async (query, parameters, limit = 100) => {
return entries;
};
module.exports = {
getCombinedUid,
getCombinedUidWhereFilter,
getUidParamsFromName,
getService,
getCoreStore,
logMessage,
sanitizeConfig,
sortByKeys,
dynamicSort,
noLimit,
};

2
server/utils/queryFallBack.js
View File

@ -33,4 +33,4 @@ const queryFallBack = {
},
};
module.exports = queryFallBack;
export default queryFallBack;

2
server/warnings.js
View File

@ -1,6 +1,6 @@
'use strict';
module.exports = {
export default {
delete: {
'user-role.public': "You've just deleted a default role from the users-permissions plugin.",
'user-role.authenticated': "You've just deleted a default role from the users-permissions plugin.",

3
strapi-admin.js
View File

@ -1,3 +0,0 @@
import admin from './admin/src';
export default admin;

19
strapi-server.js
View File

@ -1,19 +0,0 @@
'use strict';
const register = require('./server/register');
const bootstrap = require('./server/bootstrap');
const services = require('./server/services');
const routes = require('./server/routes');
const config = require('./server/config');
const controllers = require('./server/controllers');
module.exports = () => {
return {
register,
bootstrap,
routes,
config,
controllers,
services,
};
};

587
yarn.lock
View File

File diff suppressed because it is too large Load Diff