提供範例

Blockly 範例包含與 Blockly 相關的額外內容，這些內容不屬於核心存放區，包括外掛程式、程式碼研究室和範例程式碼。如要進一步瞭解這些項目，請參閱存放區結構頁面。

重要須知

以下是 Blockly 範例的快速總覽，可協助您建立 PR。

  • 工作分支是 main，所有 PR 都應針對 main 建立。
  • 在 blockly-samples 的根層級執行 npm install，而非在個別外掛程式層級。Blockly-samples 是 monorepo，也就是在同一個存放區中包含多個套件，在根層級安裝是使用 Lerna 管理 monorepo 的工作流程之一。
  • 程式碼必須符合 Google 的 JavaScript 樣式指南或 TypeScript 樣式指南，視使用的語言而定。
  • 在提交訊息和提取要求標題中使用傳統提交。

  • 所有新程式碼檔案都必須加上 Apache 2.0 版授權前置字串：

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

進行及驗證變更

  1. 在 blockly-samples 的根層級執行 npm install，安裝依附元件。
  2. 在外掛程式的目錄中執行 npm run start，即可建構及啟動伺服器，執行外掛程式的測試頁面。您可以使用這個頁面查看外掛程式的現有行為，或是新增外掛程式時，將這個頁面設為實用的測試頁面，讓其他人瞭解外掛程式的功能。詳情請參閱遊樂場頁面。
  3. 視需要變更外掛程式的程式碼。
  4. 如果伺服器仍在執行，系統會自動載入變更。 否則，請重新啟動伺服器，並確認外掛程式是否正常運作，且控制台中沒有錯誤或警告。
  5. 執行 npm run build，確保沒有建構錯誤。
  6. 在 test/ 目錄中編寫自動化 Mocha 測試。
  7. 執行 npm run test 即可執行自動化測試。
  8. 執行 npm run lint:fix 修正 Lint 錯誤。解決所有剩餘的警告或錯誤。
  9. 執行 npm run format 即可執行自動格式設定工具。
  10. 如果所有測試都通過，您就可以針對 main 開啟 PR，並提交變更。