빌드 스크립트

Blockly는 100개가 넘는 TypeScript 파일로 구성되어 있습니다. 이러한 파일은 사용하기 전에 TypeScript 컴파일러 tsc로 JavaScript로 컴파일해야 합니다. 이렇게 하면 로컬 테스트에 적합한 .js 파일이 동일한 수만큼 생성되지만 인터넷을 통해 이렇게 많은 파일을 로드하는 것은 최종 사용자에게 느린 환경을 제공합니다. Blockly의 로드 속도를 높이기 위해 Closure Compiler를 사용하여 압축 (축소)하고 압축되지 않은 파일의 절반 미만인 총 크기의 파일 ('번들' 또는 '청크')로 결합합니다.

이 과정에서 최신 ECMAScript 기능(일부 브라우저와 호환되지 않을 수 있음)을 사용하는 코드는 일반적으로 가장 널리 사용되는 브라우저와 호환되는 ES6로 트랜스파일됩니다. 따라서 최종 사용자에게는 축소된 코드만 제공하는 것이 중요합니다.

google/blockly 저장소에는 소스 코드만 포함되어 있습니다. 이전에는 빌드 제품도 포함되었지만 2019년부터 축소된 번들이 blockly NPM 패키지로 게시되었고 2022년부터는 각 GitHub 버전에 .tgz 파일로도 첨부되었으므로 Blockly 자체, 특히 core, blocks, generators 또는 msg 디렉터리의 파일을 해킹하지 않는 한 Blockly를 빌드할 필요가 없습니다.

Blockly 빌드, 테스트, 게시 프로세스는 Gulp 작업을 실행하는 npm 스크립트를 사용하여 자동화됩니다. 이 페이지에서는 원칙 스크립트와 각 스크립트의 기능을 설명합니다.

압축 및 비압축 모드

TypeScript 컴파일러에서 생성된 개별 .js 파일에서 Blockly를 직접 로드하는 것을 '압축 해제 모드'라고 합니다. 여러 느린 빌드 단계를 피하므로 빠른 수정-컴파일-실행 주기가 가능합니다. 또한 실행되는 JavaScript 코드가 원래 TypeScript 소스와 거의 동일하게 읽을 수 있으므로 소스 맵에 의존할 필요가 없어 디버깅이 용이합니다.

축소된 번들에서 Blockly를 로드하는 것을 '압축 모드'라고 합니다. 이는 blockly npm 패키지 (게시되지 않은 버전)를 테스트하므로 다른 패키지의 종속 항목으로 사용할 때 Blockly 변경사항을 테스트하는 가장 좋은 방법입니다.

N.B.: Blockly 저장소에는 '컴파일되지 않은 모드'와 '컴파일된 모드'라는 용어가 각각 '압축되지 않은 모드'와 '압축된 모드'의 동의어로 사용되는 곳이 있습니다. 이 사용법은 과거에 Closure Compiler가 코드를 압축 (축소)하는 데 사용되었기 때문에 타당했지만, 이제는 압축되지 않은 모드에서도 TypeScript 컴파일러가 항상 필요하므로 이 대체 용어는 혼동을 야기할 수 있으며 권장되지 않습니다.

빠른 시작

  • 로컬 변경사항을 적용했고 빌드나 테스트가 중단되지 않았는지 확인하려면 다음을 실행하세요.

    npm test

    Blockly를 빌드하고 테스트 도구 모음을 실행합니다.

  • 브라우저에서 로컬 변경사항을 테스트하려면 다음을 실행하세요.

    npm start

    이렇게 하면 Blockly가 컴파일되고 압축되지 않은 모드로 Blockly를 실행하는 Blockly playground를 가리키는 웹브라우저가 열립니다.

    core/, blocks/, generators/에서 수정된 파일은 자동으로 다시 컴파일됩니다. 브라우저 탭을 새로고침하여 변경사항을 확인하세요.

  • Blockly의 로컬에서 수정된 버전을 빌드하고 압축 모드에서 다른 npm 패키지의 종속 항목으로 테스트하려면 다음을 실행하세요.

    npm run package

    Blockly 패키지를 빌드합니다.

    cd dist && npm link

    컴파일된 파일을 찾을 위치를 npm에 알려준 다음 cd를 프로젝트 디렉터리로 이동한 후

    npm link blockly

    패키지가 게시된 blockly 패키지 대신 새로 컴파일된 Blockly 버전을 사용하도록 합니다.

자세한 스크립트 참조

이 섹션에는 Blockly의 package.json 파일에 있는 scripts 원칙이 기능 설명과 함께 나열되어 있습니다.

이러한 스크립트는 다음 두 위치에 파일을 생성합니다.

  • build/ 하위 디렉터리의 파일은 로컬 테스트에 사용되는 중간 파일이거나 빌드 파이프라인의 후반 부분에서 인그레스됩니다.
  • dist/ 하위 디렉터리의 파일은 게시된 npm 패키지의 콘텐츠를 구성합니다.

두 디렉터리 모두 blockly git 저장소에서 추적되지 않습니다.

clean

npm run clean은 build/ 및 dist/ 디렉터리를 삭제하여 이전 빌드를 정리합니다. 특히 소스 파일 이름 변경으로 인해 발생하는 난해한 빌드 실패를 수정하는 데 유용합니다.

messages

npm run messages는 msg/messages.js에 적용된 변경사항으로 msg/json/의 메시지 파일을 업데이트하며, 파일이 수정될 때마다 실행해야 합니다.

langfiles

npm run langfiles는 msg/json의 메시지 파일에서 build/msg/에 컴파일된 언어 파일을 생성합니다.

tsc

npm run tsc는 core/, blocks/, generators/ 디렉터리의 콘텐츠에서 타입스크립트 컴파일러를 실행하고 개별 .js 파일을 build/src/에 출력합니다.

minify

npm run minify는 closure-make-deps 및 closure-calculate-chunks를 실행하여 컴파일된 .js 파일을 청크 (최소화된 번들)로 나누는 방법을 결정한 후 closure-compiler를 실행하여 다음과 같이 청크를 만듭니다.

  • build/src/core/의 콘텐츠가 dist/blockly_compressed.js이 됩니다.
  • build/src/blocks/의 콘텐츠가 dist/blocs_compressed.js이 됩니다.
  • build/src/generators/javascript/ (및 build/src/generators/javascript.js)의 콘텐츠가 dist/javascript_compressed.js가 됩니다.
  • dart, lua, php, python도 마찬가지입니다.

생성된 청크는 래퍼를 사용하여 범용 모듈 정의와의 호환성을 보장하므로 패키지에 포함되기 전에 추가 처리가 필요하지 않습니다.

build

npm run build는 minify 및 langfiles 작업을 실행합니다. 이렇게 하면 압축 모드 또는 압축되지 않은 모드에서 Blockly playground를 로드하는 데 필요한 모든 작업이 실행됩니다.

package

npm run package는 clean 및 build 작업을 실행한 후 다음을 실행합니다.

  • build/msg/의 파일에 UMD 래퍼를 적용하여 래핑된 버전을 dist/msg/에 배치합니다.
  • 해당하는 경우 UMD 래퍼와 함께 다양한 추가 지원 파일을 dist/에 추가합니다.

publish

npm run publish는 Blockly팀이 blockly npm 패키지를 게시하는 데 사용됩니다. Google 내부 인프라에 종속되므로 외부 개발자에게는 유용하지 않습니다.

lint

npm run lint는 ESLint를 실행하여 Blockly 소스 코드의 정적 분석을 실행하여 문제를 찾습니다.

test

npm test(또는 npm run test)는 package 작업을 실행한 다음 ESLint 실행을 비롯한 다양한 자동 테스트를 실행합니다. 이는 blockly 저장소에 대해 풀 요청으로 제출된 모든 코드에서 실행되고 통과되어야 합니다.