feat: support workspaces (#369)

* feat: workspaces sort

* chore: add tests

* fix: snapshot

Author: Zamiell

index.js

@@ -103,6 +103,42 @@ const sortObjectByIdent = (a, b) => {
 // https://github.com/npm/package-json/blob/b6465f44c727d6513db6898c7cbe41dd355cebe8/lib/update-dependencies.js#L8-L21
 const sortDependenciesLikeNpm = sortObjectBy((a, b) => a.localeCompare(b, 'en'))
 
+const sortWorkspaces = (workspaces) => {
+  // workspaces can be an array (yarn classic) or an object (pnpm/bun)
+  if (Array.isArray(workspaces)) {
+    return uniqAndSortArray(workspaces)
+  }
+
+  if (isPlainObject(workspaces)) {
+    // Sort known properties in a specific order
+    const sortedWorkspaces = {}
+
+    // First add packages if it exists
+    if (workspaces.packages) {
+      sortedWorkspaces.packages = uniqAndSortArray(workspaces.packages)
+    }
+
+    // Then add catalog if it exists and sort it like dependencies
+    if (workspaces.catalog) {
+      sortedWorkspaces.catalog = sortDependenciesLikeNpm(workspaces.catalog)
+    }
+
+    // Add any other properties in alphabetical order
+    const knownKeys = ['packages', 'catalog']
+    const otherKeys = Object.keys(workspaces)
+      .filter((key) => !knownKeys.includes(key))
+      .sort()
+
+    for (const key of otherKeys) {
+      sortedWorkspaces[key] = workspaces[key]
+    }
+
+    return sortedWorkspaces
+  }
+
+  return workspaces
+}
+
 // https://github.com/eslint/eslint/blob/acc0e47572a9390292b4e313b4a4bf360d236358/conf/config-schema.js
 const eslintBaseConfigProperties = [
   // `files` and `excludedFiles` are only on `overrides[]`
@@ -325,7 +361,7 @@ const fields = [
   { key: 'man' },
   { key: 'directories', over: sortDirectories },
   { key: 'files', over: uniq },
-  { key: 'workspaces' },
+  { key: 'workspaces', over: sortWorkspaces },
   // node-pre-gyp https://www.npmjs.com/package/node-pre-gyp#1-add-new-entries-to-your-packagejson
   {
     key: 'binary',

tests/deps.js

@@ -27,29 +27,29 @@ for (const field of [
 test('peerDependenciesMeta', macro.sortObjectAlphabetically, {
   path: 'peerDependenciesMeta',
   maxDepth: 2,
-  // TODO: don't use snapshot, find a esaier way for review
+  // TODO: don't use snapshot, find a easier way for review
   expect: 'snapshot',
 })
 
 // dependenciesMeta
 test('dependenciesMeta', macro.sortObjectAlphabetically, {
   path: 'dependenciesMeta',
   maxDepth: 2,
-  // TODO: don't use snapshot, find a esaier way for review
+  // TODO: don't use snapshot, find a easier way for review
   expect: 'snapshot',
 })
 
 test('dependenciesMetaRange', macro.sortObjectWithRangeAlphabetically, {
   path: 'dependenciesMeta',
   maxDepth: 2,
-  // TODO: don't use snapshot, find a esaier way for review
+  // TODO: don't use snapshot, find a easier way for review
   expect: 'snapshot',
 })
 
 test('pnpm.overrides', macro.sortObjectWithRangeAlphabetically, {
   path: 'pnpm.overrides',
   maxDepth: 2,
-  // TODO: don't use snapshot, find a esaier way for review
+  // TODO: don't use snapshot, find a easier way for review
   expect: 'snapshot',
 })
 

tests/fields.js

@@ -32,7 +32,6 @@ for (const field of [
   'examplestyle',
   'assets',
   'man',
-  'workspaces',
   'pre-commit',
   'browserslist',
   'stylelint',

tests/snapshots/main.js.md

@@ -166,7 +166,6 @@ Generated by [AVA](https://avajs.dev).
         "man": "man",␊
         "directories": "directories",␊
         "files": "files",␊
-        "workspaces": "workspaces",␊
         "binary": "binary",␊
         "scripts": "scripts",␊
         "betterScripts": "betterScripts",␊

tests/workspaces.js

@@ -0,0 +1,51 @@
+import test from 'ava'
+import sortPackageJson from '../index.js'
+import { sortPackageJsonAsObject } from './_helpers.js'
+
+test('workspaces array (yarn) should be sorted and unique', (t) => {
+  const packageJson = {
+    workspaces: ['packages/c', 'packages/a', 'packages/b', 'packages/a'],
+  }
+  const sorted = sortPackageJson(packageJson)
+  t.deepEqual(sorted.workspaces, ['packages/a', 'packages/b', 'packages/c'])
+})
+
+test('workspaces object should be sorted', (t) => {
+  const sortedWorkspaces = sortPackageJsonAsObject({
+    path: 'workspaces',
+    value: {
+      zoo: '*', // other property
+      packages: ['packages/c', 'packages/a', 'packages/b', 'packages/a'],
+      catalog: {
+        'is-even': 'npm:is-even@1.0.0',
+        'is-odd': 'npm:is-odd@3.0.1',
+        'alpha-lib': 'npm:alpha-lib@1.0.0',
+      },
+      animal: '*', // other property
+    },
+  })
+
+  const expect = {
+    packages: ['packages/a', 'packages/b', 'packages/c'],
+    catalog: {
+      'alpha-lib': 'npm:alpha-lib@1.0.0',
+      'is-even': 'npm:is-even@1.0.0',
+      'is-odd': 'npm:is-odd@3.0.1',
+    },
+    animal: '*',
+    zoo: '*',
+  }
+
+  t.deepEqual(sortedWorkspaces, expect)
+})
+
+test('workspaces with other types should be kept as it is', (t) => {
+  for (const value of ['string', false, 2020, undefined, null]) {
+    const type = value === null ? 'null' : typeof value
+    t.is(
+      sortPackageJsonAsObject({ path: 'workspaces', value }),
+      value,
+      `Should keep ${type} type \`workspaces\` as it is.`,
+    )
+  }
+})