move the tool/bindings_generator dart+node script into the top-level …

…bindings_generator/ directory (#123)

move the tool/bindings_generator dart+node script into the top-level bindings_generator/ directory

.github/workflows/build.yml

@@ -74,7 +74,7 @@ jobs:
         run: dart pub get
       - name: Install Node dependencies
         run: npm install
-        working-directory: tool/bindings_generator
+        working-directory: bindings_generator
       - name: Run the generator
         run: dart tool/update_bindings.dart
       - name: Analyze code

.gitignore

@@ -1,6 +1,7 @@
 .dart_tool
 doc/api/
 pubspec.lock
-tool/bindings_generator/*.js
-tool/bindings_generator/*.js.*
-tool/bindings_generator/node_modules/
+
+bindings_generator/*.js
+bindings_generator/*.js.*
+bindings_generator/node_modules/

README.md

@@ -36,3 +36,6 @@ void main() {
 <!-- START updated by tool/update_bindings.dart. Do not modify by hand -->
 Based on [`@webref/idl 3.39.1`](https://www.npmjs.com/package/@webref/idl/v/3.39.1).
 <!-- END updated by tool/update_bindings.dart. Do not modify by hand -->
+
+For instructions on re-generating the DOM bindings, see
+(bindings_generator/README.md)[bindings_generator/README.md].

bindings_generator/README.md

@@ -0,0 +1,19 @@
+The bindings generator for `package:web`.
+
+This tool is written in Dart, compiled to JavaScript, and run on Node.
+
+## Generating the bindings
+
+Run:
+
+```
+dart tool/update_bindings.dart
+```
+
+## Update to the latest Web IDL versions and regenerate
+
+Run:
+
+```
+dart tool/update_bindings.dart --update
+```

tool/bindings_generator/js_type_supertypes.dart → bindings_generator/js_type_supertypes.dart

@@ -28,5 +28,5 @@ const Map<String, String?> jsTypeSupertypes = {
   'JSUint16Array': 'JSTypedArray',
   'JSUint32Array': 'JSTypedArray',
   'JSUint8Array': 'JSTypedArray',
-  'JSUint8ClampedArray': 'JSTypedArray'
+  'JSUint8ClampedArray': 'JSTypedArray',
 };

test/type_union_test.dart

@@ -3,7 +3,8 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:test/test.dart';
-import '../tool/bindings_generator/type_union.dart';
+
+import '../bindings_generator/type_union.dart';
 
 void main() {
   test('Non-JS types', () {

tool/update_bindings.dart

@@ -36,13 +36,13 @@ $_usage''');
 
   assert(p.fromUri(Platform.script).endsWith(_thisScript));
 
-  // Run `npm install` or `npm upgrade` as needed.
-  if (argResult['update'] as bool) {
-    await _runProc('npm', ['update'], workingDirectory: _bindingsGeneratorPath);
-  } else {
-    await _runProc('npm', ['install'],
-        workingDirectory: _bindingsGeneratorPath);
-  }
+  // Run `npm install` or `npm update` as needed.
+  final update = argResult['update'] as bool;
+  await _runProc(
+    'npm',
+    [update ? 'update' : 'install'],
+    workingDirectory: _bindingsGeneratorPath,
+  );
 
   // Compute JS type supertypes for union calculation in translator.
   await _generateJsTypeSupertypes();
@@ -79,7 +79,7 @@ $_usage''');
   // Run app with `node`.
   await _runProc(
     'node',
-    ['main.mjs', '../../lib/src'],
+    ['main.mjs', '../lib/src'],
     workingDirectory: _bindingsGeneratorPath,
   );
 
@@ -93,7 +93,7 @@ $_usage''');
 
   // Update readme.
   final readmeFile = File(
-    p.normalize(p.join(_bindingsGeneratorPath, '..', '..', 'README.md')),
+    p.normalize(p.join(_bindingsGeneratorPath, '..', 'README.md')),
   );
 
   final sourceContent = readmeFile.readAsStringSync();
@@ -138,8 +138,7 @@ String _webRefIdlVersion() {
   return webRefIdl['version'] as String;
 }
 
-final _bindingsGeneratorPath =
-    p.fromUri(Platform.script.resolve('bindings_generator/'));
+const _bindingsGeneratorPath = 'bindings_generator';
 
 const _webRefIdl = '@webref/idl';
 
@@ -194,6 +193,7 @@ Future<void> _generateJsTypeSupertypes() async {
       // the old code.
       void storeSupertypes(InterfaceElement element) {
         if (!_isInJsTypesOrJsInterop(element)) return;
+
         String? parentJsType;
         final supertype = element.supertype;
         final immediateSupertypes = <InterfaceType>[
@@ -222,22 +222,19 @@ Future<void> _generateJsTypeSupertypes() async {
   }
 
   final jsTypeSupertypesScript = '''
-  // Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
-  // for details. All rights reserved. Use of this source code is governed by a
-  // BSD-style license that can be found in the LICENSE file.
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
 
-  // Updated by $_thisScript. Do not modify by hand.
+// Updated by $_thisScript. Do not modify by hand.
 
-  const Map<String, String?> jsTypeSupertypes = $jsTypeSupertypes;
-  ''';
+const Map<String, String?> jsTypeSupertypes = {
+${jsTypeSupertypes.entries.map((e) => "  ${e.key}: ${e.value},").join('\n')}
+};
+''';
   final jsTypeSupertypesPath =
       p.join(_bindingsGeneratorPath, 'js_type_supertypes.dart');
   await File(jsTypeSupertypesPath).writeAsString(jsTypeSupertypesScript);
-  await _runProc(
-    Platform.executable,
-    ['format', jsTypeSupertypesPath],
-    workingDirectory: _bindingsGeneratorPath,
-  );
 }
 
 final _usage = '''