Cli: [FITUR] Izinkan jsonc atau JSON5 untuk package.json untuk berkomentar

Dibuat pada 10 Feb 2020  ·  4Komentar  ·  Sumber: npm/cli

Apa sebabnya

Jelaskan permintaan secara rinci

Baik atau buruk, konten dalam package.json telah berkembang dengan kompleksitas yang semakin besar. Pada hari-hari npm yang baru lahir, file itu hanyalah beberapa metadata pada dependensi yang bergantung pada proyek/paket. Proyek tumbuh dalam kompleksitas dan sekarang pengujian, kerangka kerja, perpustakaan lain adalah semua dependensi yang akan tampak duduk bersama. Ada beberapa pemisahan dengan dependencies dan devDependencies , tapi itu adalah kategorisasi kasar. Kami memiliki alat yang sekarang berkontribusi dan tinggal di dalam package.json dengan kompleksitas yang lebih besar... konfigurasi monorepo, konfigurasi lint, konfigurasi commit, git hooks, nodemon, jest, daftarnya terus berlanjut...

Komentar menawarkan cara untuk menjelaskan semua kerumitan.

Saya masih berpikir bahwa pengelola perpustakaan masih harus menggunakan JSON murni untuk kompatibilitas mundur, tetapi setidaknya menawarkan langkah maju ini akan memungkinkan pembuat proyek (sebagian besar pengguna) kemampuan untuk mendokumentasikan package.json mereka. Memang, json memungkinkan kunci duplikat berfungsi sebagai komentar, tetapi ini terasa seperti peretasan.

Bagaimana

Perilaku Saat Ini

Contoh yang disunting dan dibuat-buat:

{
  "name": "my-project",
  "version": "0.0.1",
  "license": "MIT",
  "scripts": {
    "build": "a bunch of scripts",
    "ci": "a bunch of scripts",
    "ci:local": "a bunch of scripts",
    "docsite": "a bunch of scripts",
    "docsite:combiner": "a bunch of scripts",
    "docsite:sassdoc": "a bunch of scripts",
    "docsite:tsdoc": "a bunch of scripts",
    "e2e": "a bunch of scripts",
    "html-sketchapp-install": "a bunch of scripts",
    "html-sketchapp": "a bunch of scripts",
    "lint": "a bunch of scripts",
    "sassdoc": "a bunch of scripts",
    "sassdoc:comp": "a bunch of scripts",
    "sassdoc:core": "a bunch of scripts",
    "start": "a bunch of scripts",
    "start:hmr": "a bunch of scripts",
    "start:qa": "a bunch of scripts",
    "start:dev": "a bunch of scripts",
    "generate-examples": "a bunch of scripts",
    "rebuild-markdown": "a bunch of scripts",
    "watch-examples": "a bunch of scripts",
    "test:cov": "a bunch of scripts",

    "test": "jest",
    "test:watch": "jest --watch",
    "test:cc": "jest --coverage"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  },
  "dependencies": {
    "@angular-devkit/build-angular": "~0.900.1",
    "@angular-devkit/build-ng-packagr": "~0.900.1",
    "@angular-devkit/core": "~9.0.0",
    "@angular-devkit/schematics": "~9.0.0",
    "@angular/animations": "~9.0.0",
    "@angular/cdk": "~9.0.0",
    "@angular/cli": "~9.0.1",
    "@angular/common": "~9.0.0",
    "@angular/compiler": "~9.0.0",
    "@angular/compiler-cli": "~9.0.0",
    "@angular/core": "~9.0.0",
    "@angular/forms": "~9.0.0",
    "@angular/language-service": "~9.0.0",
    "@angular/platform-browser": "~9.0.0",
    "@angular/platform-browser-dynamic": "~9.0.0",
    "@angular/router": "~9.0.0",
    "@angular/service-worker": "~9.0.0",
    "@angularclass/hmr": "2.1.3",
    "@ngrx/effects": "~8.6.0",
    "@ngrx/entity": "~8.6.0",
    "@ngrx/router-store": "~8.6.0",
    "@ngrx/schematics": "~8.6.0",
    "@ngrx/store": "~8.6.0",
    "@ngrx/store-devtools": "~8.6.0",
    "@types/jasmine": "~3.5.0",
    "@types/jasminewd2": "~2.0.3",
    "@types/lodash-es": "^4.17.3",
    "@types/node": "^12.11.1",
    "classlist.js": "1.1.20150312",
    "codelyzer": "^5.1.2",
    "console-polyfill": "0.3.0",
    "core-js": "^2.5.4",
    "cz-conventional-changelog": "1.2.0",
    "date-fns": "1.30.1",
    "highcharts": "^7.2.1",
    "highcharts-angular": "^2.4.0",
    "html2canvas": "^1.0.0-rc.5",
    "jasmine-core": "~3.5.0",
    "jasmine-spec-reporter": "~4.2.1",
    "karma": "~4.3.0",
    "karma-chrome-launcher": "~3.1.0",
    "karma-coverage-istanbul-reporter": "~2.1.0",
    "karma-jasmine": "~2.0.1",
    "karma-jasmine-html-reporter": "^1.4.2",
    "lodash-es": "^4.17.11",
    "mime": "~2.4.2",
    "ngrx-store-freeze": "0.2.4",
    "ngx-monaco-editor": "~8.0.0",
    "ngx-quill": "^7.3.12",
    "pdfmake": "^0.1.64",
    "prettier": "1.19.1",
    "protractor": "~5.4.3",
    "quill": "^1.3.7",
    "rxjs": "~6.5.4",
    "rxjs-compat": "^6.0.0",
    "standard-changelog": "1.0.19",
    "svgxuse": "1.2.6",
    "ts-node": "~8.3.0",
    "tsickle": "^0.35.0",
    "tslib": "^1.10.0",
    "tslint": "~5.18.0",
    "typescript": "~3.7.5",
    "web-animations-js": "~2.3.1",
    "zone.js": "~0.10.2"
  },
  "devDependencies": {
    "@types/jest": "^24.0.6",
    "jest": "^24.1.0",
    "jest-preset-angular": "^6.0.2",
    "ts-node": "~7.0.1",
    "typescript": "3.2.4"
  },
  "jest": {
    "preset": "jest-preset-angular",
    "setupTestFrameworkScriptFile": "<rootDir>/setupJest.ts"
  },
  "nodemonConfig": {
    "ignore": [
      "**/example-module.ts"
    ],
    "watch": [
      "./a/bunch/of/stuff"
    ],
    "ext": "js ts md html"
  },
  "workspaces": {
    "packages": [
      "packages/*"
    ],
    "nohoist": [
      "**"
    ]
  }
}

Perilaku yang Diharapkan

Contoh package.json dengan komentar.

{
  "name": "my-project",
  "version": "0.0.1",
  "license": "MIT",
  "scripts": {
    "build": "a bunch of scripts",
    "ci": "a bunch of scripts",
    "ci:local": "a bunch of scripts",
    // for building our documentation site
    "docsite": "a bunch of scripts",
    "docsite:combiner": "a bunch of scripts",
    "docsite:sassdoc": "a bunch of scripts",
    "docsite:tsdoc": "a bunch of scripts",
    "e2e": "a bunch of scripts",
    "lint": "a bunch of scripts",
    "sassdoc": "a bunch of scripts",
    "sassdoc:comp": "a bunch of scripts",
    "sassdoc:core": "a bunch of scripts",
    "start": "a bunch of scripts",
    "start:hmr": "a bunch of scripts",
    "start:qa": "a bunch of scripts",
    "start:dev": "a bunch of scripts",
    "generate-examples": "a bunch of scripts",
    "rebuild-markdown": "a bunch of scripts",
    "watch-examples": "a bunch of scripts",
    "test:cov": "a bunch of scripts",

    "test": "jest",
    "test:watch": "jest --watch",
    "test:cc": "jest --coverage"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  },
  "dependencies": {
    // ANGULAR
    "@angular-devkit/build-angular": "~0.900.1",
    "@angular-devkit/build-ng-packagr": "~0.900.1",
    "@angular-devkit/core": "~9.0.0",
    "@angular-devkit/schematics": "~9.0.0",
    "@angular/animations": "~9.0.0",
    "@angular/cdk": "~9.0.0",
    "@angular/cli": "~9.0.1",
    "@angular/common": "~9.0.0",
    "@angular/compiler": "~9.0.0",
    "@angular/compiler-cli": "~9.0.0",
    "@angular/core": "~9.0.0",
    "@angular/forms": "~9.0.0",
    "@angular/language-service": "~9.0.0",
    "@angular/platform-browser": "~9.0.0",
    "@angular/platform-browser-dynamic": "~9.0.0",
    "@angular/router": "~9.0.0",
    "@angular/service-worker": "~9.0.0",
    "@angularclass/hmr": "2.1.3",

    "zone.js": "~0.10.2",
    "rxjs": "~6.5.4",
    "rxjs-compat": "^6.0.0",


    // polyfills for angular 
    "console-polyfill": "0.3.0",
    "core-js": "^2.5.4",
    "classlist.js": "1.1.20150312",
    "svgxuse": "1.2.6",
    "web-animations-js": "~2.3.1",

    // lint management

    "codelyzer": "^5.1.2",
    "prettier": "1.19.1",
    "tslint": "~5.18.0",

    // changelog creation
    "cz-conventional-changelog": "1.2.0",
    "standard-changelog": "1.0.19",

    // ngrx state management 
    "@ngrx/effects": "~8.6.0",
    "@ngrx/entity": "~8.6.0",
    "@ngrx/router-store": "~8.6.0",
    "@ngrx/schematics": "~8.6.0",
    "@ngrx/store": "~8.6.0",
    "@ngrx/store-devtools": "~8.6.0",
    "ngrx-store-freeze": "0.2.4",


    // library deps

    // Graphs support
    "highcharts": "^7.2.1",
    "highcharts-angular": "^2.4.0",

    // for creating pdfs
    "html2canvas": "^1.0.0-rc.5",
    "pdfmake": "^0.1.64",

    // rich text support
    "ngx-quill": "^7.3.12",
    "quill": "^1.3.7",




    // testing
    "jasmine-core": "~3.5.0",
    "jasmine-spec-reporter": "~4.2.1",
    "karma": "~4.3.0",
    "karma-chrome-launcher": "~3.1.0",
    "karma-coverage-istanbul-reporter": "~2.1.0",
    "karma-jasmine": "~2.0.1",
    "karma-jasmine-html-reporter": "^1.4.2",

    // e2e testing
    "protractor": "~5.4.3",

    // typscript and compilation
    "ts-node": "~8.3.0",
    "tsickle": "^0.35.0",
    "tslib": "^1.10.0",
    "typescript": "~3.7.5",

    // misc deps
    "date-fns": "1.30.1",
    "lodash-es": "^4.17.11",
    "mime": "~2.4.2"
  },
  "devDependencies": {
    "@types/jasmine": "~3.5.0",
    "@types/jasminewd2": "~2.0.3",
    "@types/lodash-es": "^4.17.3",
    "@types/node": "^12.11.1",
    "@types/jest": "^24.0.6",
    "jest": "^24.1.0",
    "jest-preset-angular": "^6.0.2",
    "ts-node": "~7.0.1",
    "typescript": "3.2.4"
  },
  // complicated jest configuration here
  "jest": {
    "preset": "jest-preset-angular",
    "setupTestFrameworkScriptFile": "<rootDir>/setupJest.ts"
  },
  // use nodemon to trigger stuff
  "nodemonConfig": {
    "ignore": [
      "**/example-module.ts"
    ],
    "watch": [
      "./a/bunch/of/stuff"
    ],
    "ext": "js ts md html"
  },
  // extra libraries we are creating internally
  "workspaces": {
    "packages": [
      "packages/*"
    ],
    "nohoist": [
      "**"
    ]
  }
}

Referensi

Contoh * Terkait dengan #0 * Tergantung pada #0 * Diblokir oleh #0

https://github.com/microsoft/node-jsonc-parser

TypeScript menggunakan komentar di file tsconfig.json mereka.

Enhancement
Sumber
picture admosity
👍21 👎1

Komentar yang paling membantu

Setiap fitur baru menurut definisi tidak kompatibel - bukankah itu normal dan dalam sifat kemajuan dalam evolusi perangkat lunak apa pun?

Selain sangat mudah diperbaiki di proyek lain yang memuat package.json , hanya dengan menambahkan paket dan mengganti JSON dengan JSON5 - APInya identik.

Babel menambahkan dukungan JSON5 beberapa waktu lalu dan komunitas baru saja bergerak maju dan memperbaiki masalah kecil ini, yang tidak memakan waktu sama sekali - dan peningkatan JSON5 hanya semacam menyebar secara organik ke paket lain, peningkatan dokumentasi menyebar ke proyek, dan seterusnya.

Itu sepertinya hal yang bagus.

IMO, jangan menambah kerumitan/kebingungan hanya untuk memberikan alasan untuk tidak bergerak maju.

picture mindplay-dk pada 14 Apr 2020
👍8

Semua 4 komentar

@admosity sayangnya, ini akan menjadi tidak kompatibel:/ Juga, itu akan membutuhkan semua perangkat lunak lain yang menggunakan package.json, serta banyak paket npm, untuk memahami sintaks baru ...

burtek picture burtek pada 17 Feb 2020
❤1 👎1

Lihat https://github.com/npm/cli/issues/677

DanielRuf picture DanielRuf pada 18 Feb 2020

ini akan menjadi tidak kompatibel

Anda dapat memiliki dua file agar tetap kompatibel:
package.json
package.json5

Pengguna cukup mengedit package.json5 untuk menambahkan komentar. Npm dapat membuat (atau menimpa) package.json dan mengabaikan komentar dari package.json5.

dan-ryan picture dan-ryan pada 29 Mar 2020
👍2

Setiap fitur baru menurut definisi tidak kompatibel - bukankah itu normal dan dalam sifat kemajuan dalam evolusi perangkat lunak apa pun?

Selain sangat mudah diperbaiki di proyek lain yang memuat package.json , hanya dengan menambahkan paket dan mengganti JSON dengan JSON5 - APInya identik.

Babel menambahkan dukungan JSON5 beberapa waktu lalu dan komunitas baru saja bergerak maju dan memperbaiki masalah kecil ini, yang tidak memakan waktu sama sekali - dan peningkatan JSON5 hanya semacam menyebar secara organik ke paket lain, peningkatan dokumentasi menyebar ke proyek, dan seterusnya.

Itu sepertinya hal yang bagus.

IMO, jangan menambah kerumitan/kebingungan hanya untuk memberikan alasan untuk tidak bergerak maju.

mindplay-dk picture mindplay-dk pada 14 Apr 2020
👍8
Apakah halaman ini membantu?
0 / 5 - 0 peringkat

Masalah terkait

ahuglajbclajep picture ahuglajbclajep  ·  3Komentar
darcyclarke picture darcyclarke  ·  3Komentar
1000i100 picture 1000i100  ·  3Komentar
savek-cc picture savek-cc  ·  4Komentar
zypA13510 picture zypA13510  ·  4Komentar