feat: Create types and js for nested configs #36

yugal-dream11 · 2019-07-08T08:02:59Z

Solves #37

bin/cli

tusharmath · 2019-07-22T10:35:25Z

src/createMergedConfig.ts

+export const getAllConfigPath: <T extends NonConfigEnv>(
+  process: T
+) => Array<string> = process =>
+  glob.sync(`**/${baseConfigPathName}`, {


take the glob param as a parameter to the cli.

move this function to its own file.

tusharmath · 2019-07-22T10:35:46Z

src/createMergedConfig.ts

+  process: T
+) => Array<string> = process =>
+  glob.sync(`**/${baseConfigPathName}`, {
+    ignore: ['node_modules/**'],


ignored paths should be configurable.

tusharmath · 2019-07-22T10:38:46Z

webpack.ts

@@ -20,4 +20,4 @@ export const NodeConfigTSPlugin: {
 } = R.compose(
  setConfigResolver,
  setGlobalConfigPlugin
-)
+) as {(config: Configuration): Configuration}


why do we need type-casting here?

tusharmath · 2019-07-22T10:56:32Z

src/configPaths.ts

@@ -25,24 +25,30 @@ export type NonConfigEnv = {
 }

 export const configPaths = <T extends NonConfigEnv>(


Add a JSDoc explaining what this function is doing.
Add information about each argument that is being passed.

/** * Returns the paths for all the config files — {default, env, deployment, user} etc. * @param process - Used to know which file to load. For eg. if env=production, the env config will be env/production.json. * @param root - // TODO */

tusharmath · 2019-07-22T11:01:56Z

src/configPaths.ts

@@ -25,24 +25,30 @@ export type NonConfigEnv = {
 }

 export const configPaths = <T extends NonConfigEnv>(
-  process: T
+  process: T,
+  subPath?: string
 ): ConfigTypes => {
  const baseDIR = baseConfigPath(process)


baseConfigPath should not be dynamic any more because its being passed as an argument to this function.

tusharmath · 2019-07-22T11:09:05Z

src/createTypeAndJS.ts

+/**
+ * Write typedef and js for each path in nested config
+ */
+export const writeConfigFilesToSystem = () => {


split this into two separate functions/files.

tusharmath · 2019-07-22T11:10:09Z

src/createTypeAndJS.ts

+const getJsFileBuffer = (p: string) =>
+  defaultJsFileContent.concat(` mainConfig['${p}']`)
+
+const getTsFileBuffer = (config: Config) =>


This seems like a pure function. We can write unit tests easily for it.

config should be object

tusharmath · 2019-07-22T11:12:55Z

src/loadFileConfigs.ts

-  )
-  return itar(configPaths(process))
-}
+): Configurations<ConfigTypes> => readConfigFiles(configPaths(process))


this change seems unnecessary. Can you confirm?
If not needed can you revert this file.

tusharmath · 2019-07-22T11:22:50Z

index.ts


-import {mergeAllConfigs} from './src/mergeAllConfigs'
-export const config: Config = mergeAllConfigs(process)
+export const config: Config = createMergedConfig(process)


This rename is not needed.

tusharmath · 2019-08-06T10:45:32Z

src/bootstrap.ts

+import {generateJsFiles} from './generateJsFiles'
+import {generateTypeDefFiles} from './generateTypeDefFiles'
+
+process.env['BOOTSTRAP'] = 'true'


Never change env variables.

tusharmath · 2019-08-06T10:47:07Z

src/bootstrap.ts

+process.env['BOOTSTRAP'] = 'true'
+
+generateTypeDefFiles()
+generateJsFiles()


generateTypeDefFiles & generateTypeDefFiles should only use the default.json to create files.

tusharmath · 2019-08-06T10:47:26Z

src/checkIfBootstrap.ts

+
+export const checkIfBootstrap: <T extends NonConfigEnv>(
+  process: T
+) => boolean = process => process.env['BOOTSTRAP'] === 'true'


this file can be removed.

tusharmath · 2019-08-06T10:49:01Z

src/getAllConfigPaths.ts

+  return glob.sync(`**/${includePattern}`, {
+    ignore: getIgnorePatterns(process).map((x: string) => x + '/**'),
+    cwd: process.cwd()
+  })


filter out file paths that don't have default.json in them.

tusharmath · 2019-08-06T10:54:41Z

src/getAllConfigPaths.ts

+  process: T
+) => Array<string> = process => {
+  const includePattern = getIncludePattern(process)
+  return glob.sync(`**/${includePattern}`, {


don't change the passed user pattern.

tusharmath · 2019-08-06T10:59:19Z

src/getAllConfigPaths.ts

+
+export const getIncludePattern: <T extends ProcessArgv>(
+  process: T
+) => string = process => minimist(process.argv)['pattern'] || DEFAULT_BASE_DIR


all exported functions should be in their files.

tusharmath · 2019-08-06T11:03:58Z

src/checkIfDefaultJson.ts

+export const checkIfDefaultJson = <T extends NonConfigEnv>(
+  process: T,
+  p: string
+) => fs.existsSync(path.resolve(process.cwd(), `${p}/default.json`))


you might not need this function any more since the paths will only contain config/default.json

tusharmath · 2019-08-06T11:06:42Z

src/generateJsFiles.ts

+  "import {config as mainConfig} from 'node-config-ts' \n export const config ="
+
+export const getJsFileBuffer = (p: string) =>
+  defaultJsFileContent.concat(` mainConfig['${p}']`)


this will become a problem when u change the config directory's path.

tusharmath · 2019-08-06T11:08:39Z

src/mergeFileConfigsForPath.ts

+import {loadCLIConfigs} from './loadCliConfigs'
+import {checkIfBootstrap} from './checkIfBootstrap'
+
+export const mergeFileConfigsForPath: <T extends NonConfigEnv>(


tusharmath · 2023-01-14T05:42:07Z

Outdated. Closing for now.

yugal-dream11 added 6 commits July 4, 2019 14:30

feat(configPaths): Add subPath feature

883e913

feat(mergeFileConfigs): add util for merging file configs for given path

ec951e7

refactor(loadFileConfigs): extract file reac in a util

03da4ff

feat(cli): cli util to ceate types and js for nested config paths

9ff5427

fix(createTypesAndJS): fix default config check

9cb040b

refactor(app): Extract utils and add tests

39821eb

yugal-dream11 force-pushed the feat/nested-config-search branch from 5903a5f to 39821eb Compare July 17, 2019 08:47

yugal-dream11 added 3 commits July 19, 2019 11:33

fix(checkIfDefaultJson): Fix util with test

3c7c009

refactor(app): Remove unused functionalities

0577405

fix(readConfigFiles): Fix types and tests

36a67b6

tusharmath requested changes Jul 22, 2019

View reviewed changes

yugal-dream11 added 5 commits July 25, 2019 13:15

refactor(app): fix nominclature and documentation

01531a1

refactor(bootstarp): split functions and add tests

c0e7656

refactor(loadFileConfigs): Remove unused code, change tests

7f1a5b4

docs(mergeAllConfigs): Add JSDocs

3cc9529

fix(configPaths): refactor function to use basePath

b8a61ea

yugal-dream11 force-pushed the feat/nested-config-search branch from 68cdfee to b8a61ea Compare July 29, 2019 09:56

feat(app): cli for config and ignore pattern

0dbe671

tusharmath requested changes Aug 6, 2019

View reviewed changes

yugal-dream11 force-pushed the feat/nested-config-search branch from 357d87a to 0dbe671 Compare August 12, 2019 12:31

tusharmath closed this Jan 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create types and js for nested configs #36

feat: Create types and js for nested configs #36

yugal-dream11 commented Jul 8, 2019 •

edited

Loading

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Jul 22, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath Aug 6, 2019

tusharmath commented Jan 14, 2023

		@@ -25,24 +25,30 @@ export type NonConfigEnv = {
		}

		export const configPaths = <T extends NonConfigEnv>(

feat: Create types and js for nested configs #36

feat: Create types and js for nested configs #36

Conversation

yugal-dream11 commented Jul 8, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tusharmath commented Jan 14, 2023

yugal-dream11 commented Jul 8, 2019 •

edited

Loading