feat(config): support intellisense in .syncpackrc.js

[jamiehaywood]

Description

In lieu of having a TS config file, it would be useful to add a types key to the package.json so that we can consume the config types i.e:

/**
 * @typedef {import('syncpack').Syncpack.Config.Public} SyncpackConfig
 * @type {SyncpackConfig}
 **/
export default {
  customTypes: [],
  dependencyTypes: ['dev', 'peer', 'prod', 'workspace'],
  filter: '.',
...

Suggested Solution

Should be as simple as adding a types key to the package.json pointing to dist/types.d.ts.

Help Needed

N/A

[JamieMason]

Thanks Jamie, agree and been meaning to do this.

[jamiehaywood]

a follow up to this (can raise a separate ticket) is potentially adding a JSON schema to the dist so it can be referenced in SyncPack json config 🙂

[JamieMason]

Got this working locally, it'll look like this:

// @ts-check

/** @type {import("syncpack").RcFile} */
const config = {
  versionGroups: [
    {
      dependencies: ["@types/node"],
      packages: ["**"],
      pinVersion: "14.18.36",
    },
    {
      dependencies: ["chalk"],
      packages: ["**"],
      pinVersion: "4.1.2",
    },
  ],
};

module.exports = config;

This should hopefully help fix #132 too, as the types complain if you mix properties from different version groups for example.

[JamieMason]

Released in syncpack@10.0.0, please let me know if you run into any issues.