Add scaffolding for Node.js module in VS Code extension

strager · strager · commit 6e102d03f9fe · 2021-08-03T20:51:54.000-07:00
I want the VS Code extension to use our
change_detecting_configuration_filesystem classes. These classes need
access to OS-specific APIs, thus we need to use FFI or a Node.js
extension.

Create a super basic Node.js extension called quick-lint-js-node-fs. The
extension doesn't do anything interesting. This commit only sets up the
build process.

Also, adjust collect-copyright script to work with header-only libraries
(with manual intervention). Otherwise, node and node-addon-api get no
credit.
diff --git a/.github/workflows/build-and-test-plugin-vscode.yml b/.github/workflows/build-and-test-plugin-vscode.yml
@@ -8,8 +8,51 @@ on:
     types: [opened, synchronize]
 
 jobs:
-  build:
-    name: extension
+  build-node-addon:
+    name: Node.js addon for ${{ matrix.os.name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - {runs_on: macos-10.15, name: "macOS", archive_name: "macos", CC: /usr/local/opt/llvm/bin/clang, CXX: /usr/local/opt/llvm/bin/clang++, CFLAGS: "-isystem /usr/local/opt/llvm/include -isystem /usr/local/opt/llvm/include/c++/v1 -mmacosx-version-min=10.9 -D_LIBCPP_DISABLE_AVAILABILITY", LDFLAGS: "-L/usr/local/opt/llvm/lib -mlinker-version=278 -nostdlib++ /usr/local/opt/llvm/lib/libc++.a /usr/local/opt/llvm/lib/libc++abi.a"}
+          - {runs_on: ubuntu-latest, name: "Linux", archive_name: "linux", CC: gcc-8, CXX: g++-8, LDFLAGS: "-static-libgcc -static-libstdc++"}
+          - {runs_on: windows-latest, name: "Windows", archive_name: "windows", CMAKE_FLAGS: "-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded"}
+    runs-on: ${{ matrix.os.runs_on }}
+    container: ${{ fromJSON('["", "ghcr.io/quick-lint/quick-lint-js-github-builder:v1"]')[matrix.os.runs_on == 'ubuntu-latest'] }}
+    env:
+      CMAKE_CXX_COMPILER: ${{ matrix.os.CXX }}
+      CMAKE_CXX_FLAGS: ${{ matrix.os.CFLAGS }}
+      CMAKE_C_COMPILER: ${{ matrix.os.CC }}
+      CMAKE_C_FLAGS: ${{ matrix.os.CFLAGS }}
+      CMAKE_EXE_LINKER_FLAGS: ${{ matrix.os.LDFLAGS }}
+      CMAKE_EXTRA_FLAGS: ${{ matrix.os.CMAKE_FLAGS }}
+      CMAKE_SHARED_LINKER_FLAGS: ${{ matrix.os.LDFLAGS }}
+      QLJS_COLLECT_COPYRIGHT_NO_WARNINGS: 1
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: configure
+        run: |
+          env | grep '^CMAKE\|^QUICK_LINT_JS' | sort
+          cmake ${CMAKE_C_COMPILER+-DCMAKE_C_COMPILER="${CMAKE_C_COMPILER}"} ${CMAKE_CXX_COMPILER+-DCMAKE_CXX_COMPILER="${CMAKE_CXX_COMPILER}"} -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=NO -DCMAKE_C_FLAGS="${CMAKE_C_FLAGS}" -DCMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS}" -DCMAKE_EXE_LINKER_FLAGS="${CMAKE_EXE_LINKER_FLAGS}" -DCMAKE_SHARED_LINKER_FLAGS="${CMAKE_SHARED_LINKER_FLAGS}" -DQUICK_LINT_JS_ENABLE_VSCODE=YES ${CMAKE_EXTRA_FLAGS} -S . -B build
+        shell: bash
+      - name: build
+        run: cmake --build build --config Release --target quick-lint-js-node-fs quick-lint-js-node-fs-licenses
+      - name: install
+        run: cmake --install build --component vscode --prefix wasm
+
+      - name: upload build to workflow
+        uses: actions/upload-artifact@v2
+        with:
+          if-no-files-found: error
+          name: quick-lint-js-node-${{ matrix.os.archive_name }}
+          path: wasm/dist/
+
+  build-extension:
+    name: VS Code extension
+    needs: build-node-addon
     runs-on: ubuntu-latest
     # TODO(strager): Use ghcr.io/quick-lint/quick-lint-js-github-builder.
     env:
@@ -27,6 +70,19 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y ninja-build
 
+      - uses: actions/download-artifact@v2
+        with:
+          name: quick-lint-js-node-linux
+          path: ./wasm/dist/
+      - uses: actions/download-artifact@v2
+        with:
+          name: quick-lint-js-node-macos
+          path: ./wasm/dist/
+      - uses: actions/download-artifact@v2
+        with:
+          name: quick-lint-js-node-windows
+          path: ./wasm/dist/
+
       - name: C++ configure
         run: emcmake cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS='-O3 -flto' -DCMAKE_CXX_FLAGS='-O3 -fno-rtti -fno-exceptions -flto'
       - name: C++ build
diff --git a/.github/workflows/build-wasm.yml b/.github/workflows/build-wasm.yml
@@ -9,9 +9,16 @@ on:
 
 jobs:
   build:
-    name: wasm
-    runs-on: ubuntu-latest
-    container: ghcr.io/quick-lint/quick-lint-js-github-builder:v3
+    name: ${{ matrix.os.name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - {runs_on: macos-10.15, name: "macOS", CMAKE_FLAGS: "-G Ninja"}
+          - {runs_on: ubuntu-latest, name: "Ubuntu 16.04", CMAKE_FLAGS: "-G Ninja"}
+          - {runs_on: windows-latest, name: "Windows"}
+    runs-on: ${{ matrix.os.runs_on }}
+    container: ${{ fromJSON('["", "ghcr.io/quick-lint/quick-lint-js-github-builder:v3"]')[matrix.os.runs_on == 'ubuntu-latest'] }}
     env:
       QLJS_COLLECT_COPYRIGHT_NO_WARNINGS: 1
     steps:
@@ -21,12 +28,23 @@ jobs:
       - name: checkout
         uses: actions/checkout@v2
 
-      - name: C++ configure
-        run: emcmake cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug
-      - name: C++ build
-        run: emmake cmake --build build --target quick-lint-js-vscode quick-lint-js-vscode-licenses
-      - name: C++ install
-        run: emmake cmake --install build --component vscode --prefix wasm
+      - name: install build dependencies
+        if: ${{ matrix.os.runs_on == "macos-10.15" }}
+        run: brew install ninja
+
+      - name: C++ Node.js configure
+        run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DQUICK_LINT_JS_ENABLE_VSCODE=YES ${{ matrix.os.CMAKE_FLAGS }}
+      - name: C++ Node.js build
+        run: cmake --build build --config Debug --target quick-lint-js-node-fs quick-lint-js-node-fs-licenses
+      - name: C++ Node.js install
+        run: cmake --install build --component vscode --prefix wasm
+
+      - name: C++ wasm configure
+        run: emcmake cmake -S . -B build-emscripten -DCMAKE_BUILD_TYPE=Debug ${{ matrix.os.CMAKE_FLAGS }}
+      - name: C++ wasm build
+        run: emmake cmake --build build-emscripten --target quick-lint-js-vscode quick-lint-js-vscode-licenses
+      - name: C++ wasm install
+        run: emmake cmake --install build-emscripten --component vscode --prefix wasm
 
       - name: JS configure
         run: cd wasm && yarn install
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -10,6 +10,8 @@ project(quick-lint-js)
 include(GNUInstallDirs)
 
 option(QUICK_LINT_JS_ENABLE_BENCHMARKS "Build microbenchmark programs" OFF)
+option(QUICK_LINT_JS_ENABLE_VSCODE "Build VS Code extension bits" OFF)
+
 set(
   QUICK_LINT_JS_INSTALL_LICENSES_DIR
   "${CMAKE_INSTALL_DOCDIR}"
diff --git a/cmake/QuickLintJSCopyright.cmake b/cmake/QuickLintJSCopyright.cmake
@@ -4,7 +4,13 @@
 set(QUICK_LINT_JS_COLLECT_COPYRIGHT "${CMAKE_CURRENT_LIST_DIR}/../tools/collect-copyright")
 
 function (quick_lint_js_collect_copyright NAME)
-  cmake_parse_arguments("" "" "OUTPUT_FILE;TARGET" "" ${ARGN})
+  cmake_parse_arguments(
+    ""
+    ""
+    "OUTPUT_FILE;TARGET"
+    "EXTRA_VENDOR_PROJECTS"
+    ${ARGN}
+  )
   set(LINKMAP_FILE "${CMAKE_CURRENT_BINARY_DIR}/${_TARGET}.trace")
 
   set(ERROR_MESSAGE_SEVERITY WARNING)
@@ -69,6 +75,15 @@ function (quick_lint_js_collect_copyright NAME)
     )
   endif ()
 
+  if (_EXTRA_VENDOR_PROJECTS)
+    list(
+      APPEND
+      COLLECT_COPYRIGHT_OPTIONS
+      --extra-vendor-projects
+      ${_EXTRA_VENDOR_PROJECTS}
+    )
+  endif ()
+
   add_custom_command(
     OUTPUT "${_OUTPUT_FILE}"
     COMMAND
diff --git a/plugin/vscode/.vscodeignore b/plugin/vscode/.vscodeignore
@@ -6,7 +6,6 @@
 !node_modules/
 !node_modules/quick-lint-js-wasm/
 !node_modules/quick-lint-js-wasm/dist/
-!node_modules/quick-lint-js-wasm/dist/copyright.txt
-!node_modules/quick-lint-js-wasm/dist/quick-lint-js-vscode.wasm
+!node_modules/quick-lint-js-wasm/dist/*
 !node_modules/quick-lint-js-wasm/quick-lint-js.js
 !package.json
diff --git a/tools/collect-copyright b/tools/collect-copyright
@@ -28,6 +28,7 @@ archive_to_vendor_project = {
     "libboost.a": "boost",
     "libquick-lint-js-lib.a": None,
     "libsimdjson.a": "simdjson",
+    "node-napi.lib": None,  # Dynamically linked.
     "quick-lint-js-lib.lib": None,
     "simdjson.lib": "simdjson",
     # HACK(strager): Ignore these libraries for now.
@@ -66,6 +67,12 @@ def main() -> None:
         default=False,
         help="Don't assume system package manager manages the standard library",
     )
+    parser.add_argument(
+        "--extra-vendor-projects",
+        default=[],
+        help="Include license information for these projects from --vendor-readme",
+        nargs="+",
+    )
     parser.add_argument(
         "--vendor-readme",
         required=False,
@@ -103,6 +110,7 @@ Parts of quick-lint-js might be distributed under different licenses:
         vendor_projects=vendor_projects,
         vendor_directory=vendor_readme_file.parent,
         is_cross_compiling_emscripten=args.cross_compiling_emscripten,
+        extra_vendor_projects=args.extra_vendor_projects,
     )
 
 
@@ -111,6 +119,7 @@ def dump_from_linkmap(
     vendor_projects: typing.List["VendorReadmeProject"],
     vendor_directory: pathlib.Path,
     is_cross_compiling_emscripten: bool,
+    extra_vendor_projects: typing.List[str],
 ) -> None:
     link_map = parse_link_map(link_map_file.read_text())
     linked_system_archives = [
@@ -123,6 +132,7 @@ def dump_from_linkmap(
     ]
     dump_from_vendor(
         linked_vendored_archives,
+        project_names=extra_vendor_projects,
         vendor_projects=vendor_projects,
         vendor_directory=vendor_directory,
     )
@@ -134,9 +144,11 @@ def dump_from_linkmap(
 
 def dump_from_vendor(
     archives: typing.List[str],
+    project_names: typing.List[str],
     vendor_projects: typing.List["VendorReadmeProject"],
     vendor_directory: pathlib.Path,
 ) -> None:
+    all_project_names = project_names
     for archive in sorted(archives):
         try:
             vendor_project_name = archive_to_vendor_project[pathlib.Path(archive).name]
@@ -145,13 +157,16 @@ def dump_from_vendor(
         if vendor_project_name is None:
             # Archive is quick-lint-js itself. Its license is handled elsewhere.
             continue
+        all_project_names.append(vendor_project_name)
 
+    all_project_names = sorted(set(all_project_names))
+    for vendor_project_name in all_project_names:
         matching_vendor_projects = [
             p for p in vendor_projects if p.project_name == vendor_project_name
         ]
         if len(matching_vendor_projects) != 1:
             raise Exception(
-                f"could not find vendor project for archive: {archive} (project name: {vendor_project_name}"
+                f"could not find vendor project for project name: {vendor_project_name}"
             ) from None
         vendor_project = matching_vendor_projects[0]
 
diff --git a/vendor/CMakeLists.txt b/vendor/CMakeLists.txt
@@ -9,6 +9,8 @@ endif ()
 include(boost.cmake)
 include(googletest.cmake)
 include(jsoncpp.cmake)
+include(node-addon-api.cmake)
+include(node.cmake)
 include(simdjson.cmake)
 
 # quick-lint-js finds bugs in JavaScript programs.
diff --git a/vendor/node-addon-api.cmake b/vendor/node-addon-api.cmake
@@ -0,0 +1,25 @@
+# Copyright (C) 2020  Matthew "strager" Glazar
+# See end of file for extended copyright information.
+
+add_library(node-addon-api INTERFACE)
+target_compile_definitions(node-addon-api INTERFACE NAPI_DISABLE_CPP_EXCEPTIONS)
+target_include_directories(node-addon-api SYSTEM INTERFACE node-addon-api)
+target_link_libraries(node-addon-api INTERFACE node-napi)
+
+# quick-lint-js finds bugs in JavaScript programs.
+# Copyright (C) 2020  Matthew "strager" Glazar
+#
+# This file is part of quick-lint-js.
+#
+# quick-lint-js is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# quick-lint-js is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with quick-lint-js.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/vendor/node.cmake b/vendor/node.cmake
@@ -0,0 +1,60 @@
+# Copyright (C) 2020  Matthew "strager" Glazar
+# See end of file for extended copyright information.
+
+add_library(node-napi INTERFACE)
+target_compile_definitions(node-napi INTERFACE BUILDING_NODE_EXTENSION)
+target_include_directories(node-napi SYSTEM INTERFACE node/src)
+# Users should also set the NAPI_VERSION compile definition.
+
+if (APPLE)
+  # Allow the linker to succeed by effectively ignoring undefined-symbol errors.
+  target_link_libraries(node-napi INTERFACE "-undefined dynamic_lookup")
+endif ()
+if (WIN32)
+  # Create a .lib file for linking based on the symbol list in node.def.
+  if (CMAKE_SYSTEM_PROCESSOR STREQUAL AMD64)
+    set(LIB_MACHINE /MACHINE:X64)
+  else ()
+    set(LIB_MACHINE)
+  endif ()
+  add_custom_command(
+    OUTPUT node-napi.lib node-napi.exp
+    COMMAND
+      lib
+      "/DEF:${CMAKE_CURRENT_SOURCE_DIR}/node.def"
+      /OUT:node-napi.lib
+      /WX
+      ${LIB_MACHINE}
+    DEPENDS node.def
+    COMMENT "Generating node-napi implib"
+  )
+  add_custom_target(
+    node-napi-implib
+    DEPENDS node-napi.lib
+    SOURCES node.def
+  )
+  add_dependencies(node-napi node-napi-implib)
+  target_link_libraries(
+    node-napi
+    INTERFACE
+    "${CMAKE_CURRENT_BINARY_DIR}/node-napi.lib"
+  )
+endif ()
+
+# quick-lint-js finds bugs in JavaScript programs.
+# Copyright (C) 2020  Matthew "strager" Glazar
+#
+# This file is part of quick-lint-js.
+#
+# quick-lint-js is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# quick-lint-js is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with quick-lint-js.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/vendor/node.def b/vendor/node.def
@@ -0,0 +1,47 @@
+; Copyright (C) 2020  Matthew "strager" Glazar
+; See end of file for extended copyright information.
+
+; This file is used to create an implib (.imp) file for node.exe on Windows.
+;
+; This file contains a list of all N-API symbols exported by node.exe for use by
+; addons.
+
+LIBRARY NODE.EXE
+EXPORTS
+    napi_add_finalizer
+    napi_close_handle_scope
+    napi_create_error
+    napi_create_function
+    napi_create_reference
+    napi_create_string_utf8
+    napi_create_type_error
+    napi_delete_reference
+    napi_fatal_error
+    napi_get_and_clear_last_exception
+    napi_get_cb_info
+    napi_get_last_error_info
+    napi_get_reference_value
+    napi_is_exception_pending
+    napi_module_register
+    napi_open_handle_scope
+    napi_set_property
+    napi_throw
+    ; TODO(strager): Complete this list. Many symbols are missing.
+
+; quick-lint-js finds bugs in JavaScript programs.
+; Copyright (C) 2020  Matthew "strager" Glazar
+;
+; This file is part of quick-lint-js.
+;
+; quick-lint-js is free software: you can redistribute it and/or modify
+; it under the terms of the GNU General Public License as published by
+; the Free Software Foundation, either version 3 of the License, or
+; (at your option) any later version.
+;
+; quick-lint-js is distributed in the hope that it will be useful,
+; but WITHOUT ANY WARRANTY; without even the implied warranty of
+; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+; GNU General Public License for more details.
+;
+; You should have received a copy of the GNU General Public License
+; along with quick-lint-js.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/wasm/CMakeLists.txt b/wasm/CMakeLists.txt
diff --git a/wasm/README.md b/wasm/README.md
diff --git a/wasm/node-fs.cpp b/wasm/node-fs.cpp
diff --git a/wasm/quick-lint-js.js b/wasm/quick-lint-js.js
diff --git a/website/src/config.mjs b/website/src/config.mjs
