feat(config): Support presets in subdirectories

docs/usage/config-presets.md

@@ -33,15 +33,18 @@ In order to achieve these goals, preset configs allow for a very modular approac
 In general, GitHub, GitLab or Gitea-based preset hosting is easier than npm because you avoid the "publish" step - simply commit preset code to the default branch and it will be picked up by Renovate the next time it runs.
 An additional benefit of using source code hosting is that the same token/authentication can be reused by Renovate in case you want to make your config private.
 
-| name                    | example use          | preset    | resolves as                          | filename                          |
-| ----------------------- | -------------------- | --------- | ------------------------------------ | --------------------------------- |
-| GitHub default          | `github>abc/foo`     | `default` | `https://github.com/abc/foo`         | `default.json` or `renovate.json` |
-| GitHub with preset name | `github>abc/foo:xyz` | `xyz`     | `https://github.com/abc/foo`         | `xyz.json`                        |
-| GitLab default          | `gitlab>abc/foo`     | `default` | `https://gitlab.com/abc/foo`         | `default.json` or `renovate.json` |
-| GitLab with preset name | `gitlab>abc/foo:xyz` | `xyz`     | `https://gitlab.com/abc/foo`         | `xyz.json`                        |
-| Gitea default           | `gitea>abc/foo`      | `default` | `https://gitea.com/abc/foo`          | `default.json` or `renovate.json` |
-| Gitea with preset name  | `gitea>abc/foo:xyz`  | `xyz`     | `https://gitea.com/abc/foo`          | `xyz.json`                        |
-| Local default           | `local>abc/foo`      | `default` | `https://github.company.com/abc/foo` | `default.json` or `renovate.json` |
+| name                    | example use                | preset    | resolves as                          | filename                          |
+| ----------------------- | -------------------------- | --------- | ------------------------------------ | --------------------------------- |
+| GitHub default          | `github>abc/foo`           | `default` | `https://github.com/abc/foo`         | `default.json` or `renovate.json` |
+| GitHub with preset name | `github>abc/foo:xyz`       | `xyz`     | `https://github.com/abc/foo`         | `xyz.json`                        |
+| GitHub with preset path | `github>abc/foo//path/xyz` | `xyz`     | `https://github.com/abc/foo`         | `path/xyz.json`                   |
+| GitLab default          | `gitlab>abc/foo`           | `default` | `https://gitlab.com/abc/foo`         | `default.json` or `renovate.json` |
+| GitLab with preset name | `gitlab>abc/foo:xyz`       | `xyz`     | `https://gitlab.com/abc/foo`         | `xyz.json`                        |
+| GitLab with preset path | `gitlab>abc/foo//path/xyz` | `xyz`     | `https://gitlab.com/abc/foo`         | `path/xyz.json`                   |
+| Gitea default           | `gitea>abc/foo`            | `default` | `https://gitea.com/abc/foo`          | `default.json` or `renovate.json` |
+| Gitea with preset name  | `gitea>abc/foo:xyz`        | `xyz`     | `https://gitea.com/abc/foo`          | `xyz.json`                        |
+| Local default           | `local>abc/foo`            | `default` | `https://github.company.com/abc/foo` | `default.json` or `renovate.json` |
+| Local with preset path  | `local>abc/foo//path/xyz`  | `default` | `https://github.company.com/abc/foo` | `path/xyz.json`                   |
 
 ## Example configs
 

lib/config/presets/__snapshots__/index.spec.ts.snap

@@ -87,6 +87,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "gitea",
 }
 `;
@@ -96,6 +97,17 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
+  "presetSource": "github",
+}
+`;
+
+exports[`config/presets parsePreset parses github subdirectories 1`] = `
+Object {
+  "packageName": "some/repo",
+  "params": undefined,
+  "presetName": "somefile",
+  "presetPath": "somepath/somesubpath",
   "presetSource": "github",
 }
 `;
@@ -105,6 +117,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "somefile",
+  "presetPath": undefined,
   "presetSource": "github",
 }
 `;
@@ -114,6 +127,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "somefile/somepreset/somesubpreset",
+  "presetPath": undefined,
   "presetSource": "github",
 }
 `;
@@ -123,6 +137,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "somefile/somepreset",
+  "presetPath": undefined,
   "presetSource": "github",
 }
 `;
@@ -132,6 +147,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "gitlab",
 }
 `;
@@ -141,6 +157,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "local",
 }
 `;
@@ -150,6 +167,7 @@ Object {
   "packageName": "some/repo",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "local",
 }
 `;
@@ -159,6 +177,7 @@ Object {
   "packageName": "default",
   "params": undefined,
   "presetName": "base",
+  "presetPath": undefined,
   "presetSource": "internal",
 }
 `;
@@ -171,6 +190,7 @@ Object {
     "eslint",
   ],
   "presetName": "group",
+  "presetPath": undefined,
   "presetSource": "internal",
 }
 `;
@@ -180,6 +200,7 @@ Object {
   "packageName": "renovate-config-somepackage",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -189,6 +210,7 @@ Object {
   "packageName": "renovate-config-somepackage",
   "params": undefined,
   "presetName": "webapp",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -198,6 +220,7 @@ Object {
   "packageName": "renovate-config-somepackage",
   "params": undefined,
   "presetName": "webapp",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -209,6 +232,7 @@ Object {
     "param1",
   ],
   "presetName": "webapp",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -218,6 +242,7 @@ Object {
   "packageName": "@somescope/somepackagename",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -231,6 +256,7 @@ Object {
     "param3",
   ],
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -240,6 +266,7 @@ Object {
   "packageName": "@somescope/somepackagename",
   "params": undefined,
   "presetName": "somePresetName",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -252,6 +279,7 @@ Object {
     "param2",
   ],
   "presetName": "somePresetName",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -261,6 +289,7 @@ Object {
   "packageName": "@somescope/renovate-config",
   "params": undefined,
   "presetName": "somePresetName",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -272,6 +301,7 @@ Object {
     "param1",
   ],
   "presetName": "somePresetName",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -281,6 +311,7 @@ Object {
   "packageName": "@somescope/renovate-config",
   "params": undefined,
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;
@@ -292,6 +323,7 @@ Object {
     "param1",
   ],
   "presetName": "default",
+  "presetPath": undefined,
   "presetSource": "npm",
 }
 `;

lib/config/presets/common.ts

@@ -5,6 +5,7 @@ export type Preset = RenovateConfig & Record<string, unknown>;
 
 export type PresetConfig = {
   packageName: string;
+  presetPath?: string;
   presetName?: string;
   baseConfig?: RenovateConfig;
 };

lib/config/presets/gitea/__snapshots__/index.spec.ts.snap

@@ -22,6 +22,22 @@ Array [
 ]
 `;
 
+exports[`config/presets/gitea/index getPreset() should query custom paths 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept": "application/json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "token abc",
+      "host": "gitea.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+    },
+    "method": "GET",
+    "url": "https://gitea.com/api/v1/repos/some/repo/contents/path%2Fcustom.json?",
+  },
+]
+`;
+
 exports[`config/presets/gitea/index getPreset() should query preset within the file 1`] = `
 Array [
   Object {

lib/config/presets/gitea/index.spec.ts

@@ -142,6 +142,22 @@ describe(getName(__filename), () => {
       expect(httpMock.getTrace()).toMatchSnapshot();
     });
 
+    it('should query custom paths', async () => {
+      httpMock
+        .scope(giteaApiHost)
+        .get(`${basePath}/path%2Fcustom.json`)
+        .reply(200, {
+          content: Buffer.from('{"foo":"bar"}').toString('base64'),
+        });
+      const content = await gitea.getPreset({
+        packageName: 'some/repo',
+        presetName: 'custom',
+        presetPath: 'path',
+      });
+      expect(content).toEqual({ foo: 'bar' });
+      expect(httpMock.getTrace()).toMatchSnapshot();
+    });
+
     it('should throws not-found', async () => {
       httpMock
         .scope(giteaApiHost)
@@ -185,6 +201,7 @@ describe(getName(__filename), () => {
           .getPresetFromEndpoint(
             'some/repo',
             'default',
+            undefined,
             'https://api.gitea.example.org'
           )
           .catch(() => ({ from: 'api' }))

lib/config/presets/gitea/index.ts

@@ -40,11 +40,13 @@ export async function fetchJSONFile(
 export function getPresetFromEndpoint(
   pkgName: string,
   filePreset: string,
+  presetPath?: string,
   endpoint = Endpoint
 ): Promise<Preset> {
   return fetchPreset({
     pkgName,
     filePreset,
+    presetPath,
     endpoint,
     fetch: fetchJSONFile,
   });
@@ -53,6 +55,7 @@ export function getPresetFromEndpoint(
 export function getPreset({
   packageName: pkgName,
   presetName = 'default',
+  presetPath,
 }: PresetConfig): Promise<Preset> {
-  return getPresetFromEndpoint(pkgName, presetName, Endpoint);
+  return getPresetFromEndpoint(pkgName, presetName, presetPath, Endpoint);
 }

lib/config/presets/github/__snapshots__/index.spec.ts.snap

@@ -22,6 +22,22 @@ Array [
 ]
 `;
 
+exports[`config/presets/github/index getPreset() should query custom paths 1`] = `
+Array [
+  Object {
+    "headers": Object {
+      "accept": "application/vnd.github.v3+json",
+      "accept-encoding": "gzip, deflate",
+      "authorization": "token abc",
+      "host": "api.github.com",
+      "user-agent": "https://github.com/renovatebot/renovate",
+    },
+    "method": "GET",
+    "url": "https://api.github.com/repos/some/repo/contents/path/custom.json",
+  },
+]
+`;
+
 exports[`config/presets/github/index getPreset() should query preset within the file 1`] = `
 Array [
   Object {

lib/config/presets/github/index.spec.ts

@@ -140,6 +140,22 @@ describe(getName(__filename), () => {
       expect(httpMock.getTrace()).toMatchSnapshot();
     });
 
+    it('should query custom paths', async () => {
+      httpMock
+        .scope(githubApiHost)
+        .get(`${basePath}/path/custom.json`)
+        .reply(200, {
+          content: Buffer.from('{"foo":"bar"}').toString('base64'),
+        });
+      const content = await github.getPreset({
+        packageName: 'some/repo',
+        presetName: 'custom',
+        presetPath: 'path',
+      });
+      expect(content).toEqual({ foo: 'bar' });
+      expect(httpMock.getTrace()).toMatchSnapshot();
+    });
+
     it('should throws not-found', async () => {
       httpMock
         .scope(githubApiHost)
@@ -183,6 +199,7 @@ describe(getName(__filename), () => {
           .getPresetFromEndpoint(
             'some/repo',
             'default',
+            undefined,
             'https://api.github.example.org'
           )
           .catch(() => ({ from: 'api' }))

lib/config/presets/github/index.ts

@@ -40,11 +40,13 @@ export async function fetchJSONFile(
 export function getPresetFromEndpoint(
   pkgName: string,
   filePreset: string,
+  presetPath?: string,
   endpoint = Endpoint
 ): Promise<Preset> {
   return fetchPreset({
     pkgName,
     filePreset,
+    presetPath,
     endpoint,
     fetch: fetchJSONFile,
   });
@@ -53,6 +55,7 @@ export function getPresetFromEndpoint(
 export function getPreset({
   packageName: pkgName,
   presetName = 'default',
+  presetPath,
 }: PresetConfig): Promise<Preset> {
-  return getPresetFromEndpoint(pkgName, presetName, Endpoint);
+  return getPresetFromEndpoint(pkgName, presetName, presetPath, Endpoint);
 }