add cosmiconfig-toml-loader to peerDependenciesMeta (#1189)

* add `cosmiconfig-toml-loader` to `peerDependenciesMeta` * prettier
kamilkisiela · Dec 23, 2022 · ab2ad6d · ab2ad6d
1 parent 6962fa5
commit ab2ad6d
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 9 deletions.
diff --git a/.changeset/fluffy-kings-applaud.md b/.changeset/fluffy-kings-applaud.md
@@ -0,0 +1,5 @@
+---
+'graphql-config': minor
+---
+
+add `cosmiconfig-toml-loader` to `peerDependenciesMeta`
diff --git a/package.json b/package.json
@@ -48,12 +48,16 @@
     "json-schema": "typescript-json-schema src/types.ts IGraphQLConfig --out config-schema.json --ignoreErrors --required --titles && prettier --write config-schema.json"
   },
   "peerDependencies": {
+    "cosmiconfig-toml-loader": "^1.0.0",
     "cosmiconfig-typescript-loader": "^4.0.0",
     "graphql": "^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "peerDependenciesMeta": {
     "cosmiconfig-typescript-loader": {
       "optional": true
+    },
+    "cosmiconfig-toml-loader": {
+      "optional": true
     }
   },
   "dependencies": {
@@ -64,7 +68,6 @@
     "@graphql-tools/url-loader": "^7.9.7",
     "@graphql-tools/utils": "^8.6.5",
     "cosmiconfig": "8.0.0",
-    "cosmiconfig-toml-loader": "1.0.0",
     "minimatch": "4.2.1",
     "string-env-interpolation": "1.0.1",
     "tslib": "^2.4.0"
@@ -76,6 +79,7 @@
     "@typescript-eslint/eslint-plugin": "5.47.0",
     "@typescript-eslint/parser": "5.47.0",
     "bob-the-bundler": "4.2.0-alpha-20221222140753-fcf5286",
+    "cosmiconfig-toml-loader": "1.0.0",
     "cosmiconfig-typescript-loader": "4.3.0",
     "del": "6.1.1",
     "eslint": "8.25.0",

diff --git a/src/helpers/cosmiconfig.ts b/src/helpers/cosmiconfig.ts
@@ -1,5 +1,4 @@
 import { cosmiconfig, cosmiconfigSync, Loader, defaultLoaders } from 'cosmiconfig';
-import { loadToml } from 'cosmiconfig-toml-loader';
 import { env } from 'string-env-interpolation';
 
 export interface ConfigSearchResult {
@@ -43,10 +42,15 @@ export function createCosmiConfigSync(moduleName: string, legacy: boolean) {
 const loadTypeScript: Loader = (...args) => {
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const { TypeScriptLoader } = require('cosmiconfig-typescript-loader');
-
   return TypeScriptLoader({ transpileOnly: true })(...args);
 };
 
+const loadToml: Loader = (...args) => {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const { loadToml } = require('cosmiconfig-toml-loader');
+  return createCustomLoader(loadToml)(...args);
+};
+
 function prepareCosmiconfig(moduleName: string, legacy: boolean) {
   const loadYaml = createCustomLoader(defaultLoaders['.yaml']);
 
@@ -83,7 +87,7 @@ function prepareCosmiconfig(moduleName: string, legacy: boolean) {
       '.json': createCustomLoader(defaultLoaders['.json']),
       '.yaml': loadYaml,
       '.yml': loadYaml,
-      '.toml': createCustomLoader(loadToml),
+      '.toml': loadToml,
       noExt: loadYaml,
     },
   };

diff --git a/website/src/pages/docs/index.mdx b/website/src/pages/docs/index.mdx
@@ -46,6 +46,8 @@ extensions:
 schema = "https://localhost:8080"
 ```
 
+<Callout type="warning">**Note**: This config requires `cosmiconfig-toml-loader` to be installed.</Callout>
+
 ### `graphql.config.js` or `.graphqlrc.js`
 
 ```js
@@ -66,6 +68,10 @@ const config: IGraphQLConfig = {
 export default config
 ```
 
+<Callout type="warning">
+  **Note**: This config requires `cosmiconfig-typescript-loader`, `typescript` and `ts-node` to be installed.
+</Callout>
+
 ### Custom Paths
 
 Custom extension paths with `.mycustomrc.js`, `mycustom.config.yml`, etc. - any filename listed in [usage docs](usage) with `graphql` replaced by the `loadConfig(){:ts}` parameter [`configName`](load-config#configname).

diff --git a/website/src/pages/docs/library/load-config.mdx b/website/src/pages/docs/library/load-config.mdx
@@ -6,7 +6,7 @@ This function is the starting point for using GraphQL Config. It looks for a con
 
 ### A Basic Usage Example (async):
 
-```ts filename="ts"
+```ts
 import { loadConfig } from 'graphql-config'
 
 async function main() {
@@ -16,11 +16,13 @@ async function main() {
 
 ### Synchronous Version:
 
-```ts filename="ts"
+```ts
 import { loadConfigSync } from 'graphql-config'
 
 function main() {
-  const config = loadConfigSync({ ... }) // an instance of GraphQLConfig
+  const config = loadConfigSync({
+    /* ... */
+  }) // an instance of GraphQLConfig
 }
 ```
 

diff --git a/website/src/pages/docs/user/documents.mdx b/website/src/pages/docs/user/documents.mdx
@@ -6,7 +6,7 @@ GraphQL Config supports not only a schema but GraphQL Operations and Fragments t
 
 You can specify a list of files:
 
-```yaml filename="yaml"
+```yaml
 documents:
   - ./documents/foo.graphql
   - ./documents/bar.graphql
@@ -15,7 +15,7 @@ documents:
 
 Use a glob pattern to find and include operations and fragments:
 
-```yaml filename="yaml"
+```yaml
 documents: ./documents/*.graphql
 ```