refactor: create shared workspace (freeCodeCamp#51454)

.eslintignore

@@ -3,11 +3,10 @@ client/.cache/**
 client/public/**
 api-server/src/public/**
 api-server/lib/**
-config/i18n.js
-config/misc.js
-config/certification-settings.js
-config/donation-settings.js
-config/superblocks.js
+shared/config/i18n.js
+shared/config/certification-settings.js
+shared/config/donation-settings.js
+shared/config/superblocks.js
 web/**
 docs/**/*.md
 tools/ui-components/dist/**

.eslintrc.json

@@ -68,10 +68,9 @@
           "./client/tsconfig.json",
           "./tsconfig.json",
           "./api/tsconfig.json",
-          "./config/tsconfig.json",
+          "./shared/tsconfig.json",
           "./tools/ui-components/tsconfig.json",
           "./tools/client-plugins/browser-scripts/tsconfig.json",
-          "./utils/tsconfig.json",
           "./web/tsconfig.json",
           "./curriculum-server/tsconfig.json",
           "./cypress/tsconfig.json",

.github/labeler.yml

@@ -22,4 +22,4 @@
   - docs/i18n/**/*
   - client/i18n/**/*
   - config/crowdin/**/*
-  - config/i18n/**/*
+  - shared/config/i18n/**/*

.github/workflows/crowdin-download.curriculum.yml

@@ -327,7 +327,7 @@ jobs:
         run: |
           echo pnpm version $(pnpm -v)
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
           pnpm run build:server
 

.github/workflows/e2e-mobile.yml

@@ -47,7 +47,7 @@ jobs:
       - name: Install and Build
         run: |
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
 
       - name: Generate mobile test files

.github/workflows/e2e-playwright.yml

@@ -124,7 +124,7 @@ jobs:
       - name: Install and Build
         run: |
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
           pnpm run build:server
 

.github/workflows/e2e-web.yml

@@ -130,7 +130,7 @@ jobs:
       - name: Install and Build
         run: |
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
           pnpm run build:server
 

.github/workflows/node.js-tests.yml

@@ -64,7 +64,7 @@ jobs:
         run: |
           echo pnpm version $(pnpm -v)
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           npm i --prefix=curriculum-server
           npm i --prefix=web
           pnpm run build:curriculum
@@ -144,7 +144,7 @@ jobs:
         run: |
           echo pnpm version $(pnpm -v)
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
 
       - name: Run Tests
@@ -192,7 +192,7 @@ jobs:
         run: |
           echo pnpm version $(pnpm -v)
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
 
       - name: Run Tests
@@ -241,7 +241,7 @@ jobs:
         run: |
           echo pnpm version $(pnpm -v)
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
 
       - name: Run Tests
@@ -292,7 +292,7 @@ jobs:
         run: |
           echo pnpm version $(pnpm -v)
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
 
       # DONT REMOVE THIS STEP.
       # TODO: Refactor and use re-usable workflow and shared artifacts

.github/workflows/temporary-container-checks.yml

@@ -145,7 +145,7 @@ jobs:
       - name: Install and Build
         run: |
           pnpm install
-          pnpm run create:config
+          pnpm run create:shared
           pnpm run build:curriculum
           pnpm run build:server
 

.gitignore

@@ -157,24 +157,15 @@ jspm_packages/
 .netlify
 
 ### Generated config files ###
-config/env.json
-config/curriculum.json
-config/i18n.js
-config/misc.js
-config/certification-settings.js
-config/donation-settings.js
-config/superblocks.js
-config/superblocks.test.js
-config/challenge-types.js
-config/constants.js
+shared/config/curriculum.json
+shared/config/*.js
 
 ### Generated utils files ###
-utils/index.js
-utils/get-lines.js
-utils/get-lines.test.js
-utils/validate.js
-utils/validate.test.js
-utils/is-audited.js
+shared/utils/get-lines.js
+shared/utils/get-lines.test.js
+shared/utils/validate.js
+shared/utils/validate.test.js
+shared/utils/is-audited.js
 
 ### Old Generated files ###
 # These files are no longer generated by the client, but can

.prettierignore

@@ -6,14 +6,14 @@ client/config/browser-scripts/*.json
 **/*fixtures*
 curriculum/challenges/_meta/*/*
 curriculum/challenges/**/*
-config/**/*.json
-config/*.js
-utils/index.js
-utils/get-lines.js
-utils/get-lines.test.js
-utils/validate.js
-utils/validate.test.js
-utils/is-audited.js
+client/config/*.json
+shared/config/*.js
+shared/config/curriculum.json
+shared/utils/get-lines.js
+shared/utils/get-lines.test.js
+shared/utils/validate.js
+shared/utils/validate.test.js
+shared/utils/is-audited.js
 pnpm-lock.yaml
 web/.next
 curriculum-server/data/curriculum.json

api-server/src/common/models/user.js

@@ -15,7 +15,7 @@ import uuid from 'uuid/v4';
 import { isEmail } from 'validator';
 
 import { isProfane } from 'no-profanity';
-import { blocklistedUsernames } from '../../../../config/constants';
+import { blocklistedUsernames } from '../../../../shared/config/constants';
 
 import { wrapHandledError } from '../../server/utils/create-handled-error.js';
 import {

api-server/src/server/boot/certificate.js

@@ -15,7 +15,7 @@ import {
   oldDataVizId,
   currentCertifications,
   upcomingCertifications
-} from '../../../../config/certification-settings';
+} from '../../../../shared/config/certification-settings';
 import { reportError } from '../middlewares/sentry-error-handler.js';
 
 import { deprecatedEndpoint } from '../utils/disabled-endpoints';

api-server/src/server/boot/challenge.js

@@ -17,7 +17,7 @@ import fetch from 'node-fetch';
 import jwt from 'jsonwebtoken';
 
 import { jwtSecret } from '../../../config/secrets';
-import { challengeTypes } from '../../../../config/challenge-types';
+import { challengeTypes } from '../../../../shared/config/challenge-types';
 
 import {
   fixPartiallyCompletedChallengeItem,

api-server/src/server/boot/donate.js

@@ -1,7 +1,7 @@
 import debug from 'debug';
 import Stripe from 'stripe';
 
-import { donationSubscriptionConfig } from '../../../../config/donation-settings';
+import { donationSubscriptionConfig } from '../../../../shared/config/donation-settings';
 import keys from '../../../config/secrets';
 import {
   getAsyncPaypalToken,

api-server/src/server/boot/settings.js

@@ -3,7 +3,7 @@ import { check } from 'express-validator';
 import _ from 'lodash';
 import isURL from 'validator/lib/isURL';
 
-import { isValidUsername } from '../../../../utils/validate';
+import { isValidUsername } from '../../../../shared/utils/validate';
 import { alertTypes } from '../../common/utils/flash.js';
 import {
   deprecatedEndpoint,

api-server/src/server/component-passport.js

@@ -2,7 +2,7 @@ import { PassportConfigurator } from '@freecodecamp/loopback-component-passport'
 import dedent from 'dedent';
 import passport from 'passport';
 
-import { availableLangs } from '../../../config/i18n';
+import { availableLangs } from '../../../shared/config/i18n';
 import { jwtSecret } from '../../config/secrets';
 import passportProviders from './passport-providers';
 import { setAccessTokenToResponse } from './utils/getSetAccessToken';

api-server/src/server/utils/donation.js

@@ -2,7 +2,7 @@
 import axios from 'axios';
 import debug from 'debug';
 import isEmail from 'validator/lib/isEmail';
-import { donationSubscriptionConfig } from '../../../../config/donation-settings';
+import { donationSubscriptionConfig } from '../../../../shared/config/donation-settings';
 import keys from '../../../config/secrets';
 
 const log = debug('fcc:boot:donate');

api-server/src/server/utils/get-curriculum.js

@@ -7,7 +7,7 @@ import { flatten } from 'lodash';
 // collected.
 
 // eslint-disable-next-line import/no-unresolved
-import curriculum from '../../../../config/curriculum.json';
+import curriculum from '../../../../shared/config/curriculum.json';
 
 export function getChallenges() {
   return Object.keys(curriculum)

api-server/src/server/utils/redirection.js

@@ -2,7 +2,7 @@ const jwt = require('jsonwebtoken');
 const { allowedOrigins } = require('../../../config/cors-settings');
 // process.env.HOME_LOCATION is being used as a fallback here. If the one
 // provided by the client is invalid we default to this.
-const { availableLangs } = require('../../../../config/i18n');
+const { availableLangs } = require('../../../../shared/config/i18n');
 
 function getReturnTo(
   encryptedParams,

api-server/src/server/utils/stripeHelpers.js

@@ -3,7 +3,7 @@ import {
   durationKeysConfig,
   donationOneTimeConfig,
   donationSubscriptionConfig
-} from '../../../../config/donation-settings';
+} from '../../../../shared/config/donation-settings';
 
 export function validStripeForm(amount, duration, email) {
   return isEmail('' + email) &&

api/src/routes/challenge.test.ts

@@ -2,7 +2,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 import { omit } from 'lodash';
-import { challengeTypes } from '../../../config/challenge-types';
+import { challengeTypes } from '../../../shared/config/challenge-types';
 import { devLogin, setupServer, superRequest } from '../../jest.utils';
 
 const isValidChallengeCompletionErrorMsg = {

api/src/routes/challenge.ts

@@ -1,7 +1,7 @@
 import { type FastifyPluginCallbackTypebox } from '@fastify/type-provider-typebox';
 import jwt from 'jsonwebtoken';
 import { uniqBy } from 'lodash';
-import { challengeTypes } from '../../../config/challenge-types';
+import { challengeTypes } from '../../../shared/config/challenge-types';
 import { schemas } from '../schemas';
 import {
   jsCertProjectIds,

api/src/routes/settings.ts

@@ -1,7 +1,7 @@
 import { type FastifyPluginCallbackTypebox } from '@fastify/type-provider-typebox';
 import { isProfane } from 'no-profanity';
-import { isValidUsername } from '../../../utils/validate';
-import { blocklistedUsernames } from '../../../config/constants';
+import { isValidUsername } from '../../../shared/utils/validate';
+import { blocklistedUsernames } from '../../../shared/config/constants';
 import { schemas } from '../schemas';
 
 /**

api/src/utils/common-challenge-functions.ts

@@ -1,7 +1,7 @@
 import { user } from '@prisma/client';
 import { FastifyInstance } from 'fastify';
 import { omit, pick } from 'lodash';
-import { challengeTypes } from '../../../config/challenge-types';
+import { challengeTypes } from '../../../shared/config/challenge-types';
 import { getChallenges } from './get-challenges';
 
 export const jsCertProjectIds = [

api/src/utils/get-challenges.ts

@@ -3,8 +3,8 @@
 // redirectToCurrentChallenge and, instead, only report the current challenge id
 // via the user object, then we should *not* store this so it can be garbage
 // collected.
-import curriculum from '../../../config/curriculum.json';
-import { SuperBlocks } from '../../../config/superblocks';
+import curriculum from '../../../shared/config/curriculum.json';
+import { SuperBlocks } from '../../../shared/config/superblocks';
 
 type Curriculum = { [keyValue in SuperBlocks]?: CurriculumProps };
 

client/.gitignore

@@ -18,3 +18,7 @@ i18n/locales/**/trending.json
 # TODO: Remove once you've figured out why it's generated.
 # JS that probably should not be generated
 src/components/Donation/types.js
+
+# Config
+
+config/env.json

client/config/cert-and-project-map.test.ts

@@ -3,7 +3,7 @@ import {
   currentCertifications,
   upcomingCertifications,
   legacyCertifications
-} from '../../config/certification-settings';
+} from '../../shared/config/certification-settings';
 import {
   currentCertTitles,
   upcomingCertTitles,

client/config/cert-and-project-map.ts

@@ -3,8 +3,8 @@ import {
   legacyCertifications,
   upcomingCertifications,
   currentCertifications
-} from '../../config/certification-settings';
-import config from '../../config/env.json';
+} from '../../shared/config/certification-settings';
+import config from '../config/env.json';
 
 const { showUpcomingChanges } = config;
 

client/gatsby-config.js

@@ -1,5 +1,5 @@
 const path = require('path');
-const envData = require('../config/env.json');
+const envData = require('./config/env.json');
 const {
   buildChallenges,
   replaceChallengeNode,

client/gatsby-node.js

@@ -4,7 +4,7 @@ const { createFilePath } = require('gatsby-source-filesystem');
 const uniq = require('lodash/uniq');
 const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');
 const webpack = require('webpack');
-const env = require('../config/env.json');
+const env = require('./config/env.json');
 
 const {
   createChallengePages,