Expose a function to get the default config (#6)

* Expose a function to get the default config

This is useful for filling in gaps where the user doesn't have a config.

* Add test for getDefaultConfig() + tweak exception

Co-authored-by: Pelle Wessman <[email protected]>

Author: bcomnes

index.js

@@ -189,7 +189,19 @@ async function parseV1SocketConfig (parsedV1Content) {
   return v2
 }
 
+/** @returns {SocketYml} */
+function getDefaultConfig () {
+  const config = { version: 2 }
+
+  if (!validate(config)) {
+    throw new Error('Unexpectedly invalid default config')
+  }
+
+  return config
+}
+
 module.exports = {
+  getDefaultConfig,
   parseSocketConfig,
   readSocketConfig,
   SocketValidationError,

test/parse.spec.js

@@ -7,14 +7,17 @@ const chai = require('chai')
 const chaiAsPromised = require('chai-as-promised')
 
 const {
+  getDefaultConfig,
   parseSocketConfig,
   SocketValidationError,
 } = require('../index.js')
 
 chai.use(chaiAsPromised)
 chai.should()
 
+/** @type {import('../index.js').SocketYml} */
 const defaults = {
+  'version': 2,
   'githubApp': {},
   'issueRules': {},
   'projectIgnorePaths': [],
@@ -78,7 +81,7 @@ bar: {{ def }} {{ efg }}
 version: 2
 foo: true
 `)
-      .should.eventually.become({ version: 2, ...defaults })
+      .should.eventually.become(defaults)
   })
 
   it('should coerce types', async () => {
@@ -87,9 +90,14 @@ version: 2
 projectIgnorePaths: foobar
 `)
       .should.eventually.become({
-        version: 2,
         ...defaults,
         projectIgnorePaths: ['foobar'],
       })
   })
 })
+
+describe('getDefaultConfig()', () => {
+  it('should return a default config', () => {
+    getDefaultConfig().should.deep.equal(defaults)
+  })
+})