feat(yaml): add yaml as valid file format

[dabcoder]

To keep discussing github#700

[anderssonjohan]

@dabcoder Nice! Can you also update the README and remove the comment about .yaml being ignored? 🙏

[dabcoder]

Thanks for the feedback @anderssonjohan. I can certainly update the README.
Test wise, as far as I can see the getRepoConfigs method does not return anything that can be unit tested (unless I am mistaken), and I am also unsure how to test the childPluginsList method (test the content of the childPlugins array?). Let me know if you have any pointers in that area.
EDIT: getRepoConfigs does return an Object.

[anderssonjohan]

@dabcoder If I were you I would start by isolating the code under test into a helper function and test that. Then you only have to test the changed logic and not everything around it.

1. Extract function, something like:

function getRepoOverrideConfig(repoConfigs, repository) {
  return repoConfigs[`${repository.repo}.yml`];
}

2. Write failing test

const repoConfigs = { "repository.yaml": "yaml file was picked" };
const repo = { repo: "repository" };

expect(getRepoOverrideConfig(repoConfigs, repo).toEqual("yaml file was picked");

3. Update the helper with your suggested changes
4. Write a test for current behavior

const repoConfigs = { "repository.yml": "yml file was picked" };
const repo = { repo: "repository" };

expect(getRepoOverrideConfig(repoConfigs, repo).toEqual("yml file was picked");

5. Document the precedence with a test

const repoConfigs = { "repository.yaml": "yaml file was picked", "repository.yml": "yml file was picked" };
const repo = { repo: "repository" };

expect(getRepoOverrideConfig(repoConfigs, repo).toEqual("yml file was picked");

[dabcoder]

● Settings Tests › getRepoOverrideConfig › repository defined in a file using the .yaml extension › Picks up a repository defined in file using the .yaml extension

    TypeError: Cannot read properties of undefined (reading 'repository.yml')

      415 |
      416 |   getRepoOverrideConfig(repoName) {
    > 417 |     return this.repoConfigs[`${repoName}.yml`] || this.repoConfigs[`${repoName}.yaml`] || {}
          |                            ^
      418 |   }
      419 |
      420 |   validate (section, baseConfig, overrideConfig) {

      at Settings.getRepoOverrideConfig (lib/settings.js:417:28)
      at Object.getRepoOverrideConfig (test/unit/lib/settings.test.js:156:37)

  ● Settings Tests › getRepoOverrideConfig › repository defined in a file using the .yml extension › Picks up a repository defined in file using the .yml extension

    TypeError: Cannot read properties of undefined (reading 'repository.yml')

      415 |
      416 |   getRepoOverrideConfig(repoName) {
    > 417 |     return this.repoConfigs[`${repoName}.yml`] || this.repoConfigs[`${repoName}.yaml`] || {}
          |                            ^
      418 |   }
      419 |
      420 |   validate (section, baseConfig, overrideConfig) {

      at Settings.getRepoOverrideConfig (lib/settings.js:417:28)
      at Object.getRepoOverrideConfig (test/unit/lib/settings.test.js:175:37)

[anderssonjohan]

@dabcoder You're passing the repoConfigs as the config object but they are not read from the config. They are loaded here:

safe-settings/lib/settings.js

Line 278 in 0590f68

this.repoConfigs = await this.getRepoConfigs(repo)

You can probably fix it by:

settings = createSettings({}).repoConfigs = ...

[dabcoder]

@anderssonjohan would you have time to take a look at my PR against the main repo?

[dabcoder]

Upstream PR was merged, closing this.