feat: support Visual Studio Code extension manifest (#117)

* feat: support `Visual Studio Code extension manifest`

* fix: `categories`

* fix: `qna`

* chore: typo in comment

* chore: mark `not decided`

* fix: sort all keys

* refactor: `sortProperty` -> `overProperty`

index.js

@@ -45,6 +45,7 @@ const sortESLintConfig = sortObjectBy([
  'noInlineConfig',
  'reportUnusedDisableDirectives',
 ])
+const sortVSCodeBadgeObject = sortObjectBy(['description', 'url', 'href'])
 
 const sortPrettierConfigKeys = onObject(config =>
  sortObjectKeys(config, [
@@ -107,24 +108,35 @@ const sortScripts = scripts => {
  return sortObjectBy(order)(scripts)
 }
 
+// fields marked `vscode` are for `Visual Studio Code extension manifest` only
+// https://code.visualstudio.com/api/references/extension-manifest
+// Supported fields:
+// publisher, displayName, categories, galleryBanner, preview, contributes,
+// activationEvents, badges, markdown, qna, extensionPack,
+// extensionDependencies, icon
+
 // field.key{string}: field name
 // field.over{function}: sort field subKey
 const fields = [
  { key: 'name' },
+ /* vscode */ { key: 'displayName' },
  { key: 'version' },
  { key: 'private' },
  { key: 'description' },
+ /* vscode */ { key: 'categories', over: uniq },
  { key: 'keywords', over: uniq },
  { key: 'homepage' },
  { key: 'bugs', over: sortObjectBy(['url', 'email']) },
  { key: 'repository', over: sortURLObject },
  { key: 'funding', over: sortURLObject },
  { key: 'license', over: sortURLObject },
+ /* vscode */ { key: 'qna' },
  { key: 'author', over: sortPeopleObject },
  {
  key: 'contributors',
  over: onArray(contributors => contributors.map(sortPeopleObject)),
  },
+ /* vscode */ { key: 'publisher' },
  { key: 'files', over: uniq },
  { key: 'sideEffects' },
  { key: 'type' },
@@ -160,6 +172,8 @@ const fields = [
  },
  { key: 'scripts', over: sortScripts },
  { key: 'betterScripts', over: sortScripts },
+ /* vscode */ { key: 'contributes', over: sortObject },
+ /* vscode */ { key: 'activationEvents', over: uniq },
  { key: 'husky', over: overProperty('hooks', sortGitHooks) },
  { key: 'pre-commit' },
  { key: 'commitlint', over: sortObject },
@@ -185,13 +199,23 @@ const fields = [
  { key: 'optionalDependencies', over: sortObject },
  { key: 'bundledDependencies', over: sortArray },
  { key: 'bundleDependencies', over: sortArray },
+ /* vscode */ { key: 'extensionPack', over: sortArray },
+ /* vscode */ { key: 'extensionDependencies', over: sortArray },
  { key: 'flat' },
  { key: 'engines', over: sortObject },
  { key: 'engineStrict', over: sortObject },
  { key: 'os' },
  { key: 'cpu' },
  { key: 'preferGlobal', over: sortObject },
  { key: 'publishConfig', over: sortObject },
+ /* vscode */ { key: 'icon' },
+ /* vscode */ {
+ key: 'badges',
+ over: onArray(badge => badge.map(sortVSCodeBadgeObject)),
+ },
+ /* vscode */ { key: 'galleryBanner', over: sortObject },
+ /* vscode */ { key: 'preview' },
+ /* vscode */ { key: 'markdown' },
 ]
 
 const defaultSortOrder = fields.map(({ key }) => key)

test.js

@@ -184,6 +184,7 @@ assert.deepStrictEqual(
 for (const field of [
  'exports',
  'bin',
+ 'contributes',
  'commitlint',
  'lint-staged',
  'config',
@@ -199,6 +200,7 @@ for (const field of [
  'engineStrict',
  'preferGlobal',
  'publishConfig',
+ 'galleryBanner',
 ]) {
  testField(field, [
  {
@@ -220,11 +222,15 @@ for (const field of [
 // simple disabled subKey sorting test
 for (const field of [
  'name',
+ 'displayName',
  'version',
  'description',
  'sideEffects',
  'files',
+ 'categories',
  'keywords',
+ 'qna',
+ 'publisher',
  'type',
  'main',
  'umd:main',
@@ -242,13 +248,17 @@ for (const field of [
  'assets',
  'man',
  'workspaces',
+ 'activationEvents',
  'pre-commit',
  'browserslist',
  'eslintIgnore',
  'stylelint',
  'flat',
  'os',
  'cpu',
+ 'icon',
+ 'preview',
+ 'markdown',
 ]) {
  testField(field, [
  {
@@ -457,6 +467,29 @@ assert.deepStrictEqual(
  ['foo', 'bar', ['foo', 'bar']],
 )
 
+// badges
+assert.deepStrictEqual(
+ Object.keys(
+ sortPackageJson({
+ badges: [
+ {
+ [UNKNOWN]: UNKNOWN,
+ href: 'https://travis-ci.com/keithamus/sort-package-json.svg',
+ url: 'https://travis-ci.com/keithamus/sort-package-json',
+ description: 'sort-package-json build status',
+ },
+ ],
+ }).badges[0],
+ ),
+ ['description', 'url', 'href', UNKNOWN],
+)
+assert.deepStrictEqual(
+ sortPackageJson({
+ badges: ['foo', 'bar', ['foo', 'bar']],
+ }).badges,
+ ['foo', 'bar', ['foo', 'bar']],
+)
+
 testField('directories', [
  {
  value: {
@@ -567,7 +600,12 @@ for (const field of [
 }
 
 // bundledDependencies
-for (const field of ['bundledDependencies', 'bundleDependencies']) {
+for (const field of [
+ 'bundledDependencies',
+ 'bundleDependencies',
+ 'extensionPack',
+ 'extensionDependencies',
+]) {
  testField(field, [
  {
  value: ['z', 'a'],