@basketry/sorbet - npm Package Compare versions

Comparing version 0.0.12 to 0.0.13

lib/interface-factory.js

@@ -35,2 +35,11 @@ "use strict";
     }
+    *magicComments() {
+        var _a, _b, _c;
+        if ((_c = (_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.sorbet) === null || _b === void 0 ? void 0 : _b.magicComments) === null || _c === void 0 ? void 0 : _c.length) {
+            for (const magicComment of this.options.sorbet.magicComments) {
+                yield `# ${magicComment}`;
+            }
+            yield '';
+        }
+    }
     buildInterfaceFile(int) {
@@ -47,2 +56,3 @@ return {
         yield '';
+        yield* this.magicComments();
         yield '# typed: strict';
@@ -145,2 +155,3 @@ yield '';
         yield '';
+        yield* this.magicComments();
         yield '# typed: strict';
@@ -184,2 +195,3 @@ yield '';
         yield '';
+        yield* this.magicComments();
         yield '# typed: strict';
@@ -186,0 +198,0 @@ yield '';

lib/interface-factory.test.js

@@ -18,2 +18,3 @@ "use strict";
                 enumsModule: 'enums',
+                magicComments: ['frozen_string_literal: true'],
             },
@@ -20,0 +21,0 @@ });

package.json

 {
   "name": "@basketry/sorbet",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Basketry generator for generating Sorbet types and interfaces",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -29,3 +29,3 @@ [![main](https://github.com/basketry/sorbet/workflows/build/badge.svg?branch=main&event=push)](https://github.com/basketry/sorbet/actions?query=workflow%3Abuild+branch%3Amain+event%3Apush)
   "generators": ["@basketry/sorbet"],
-  "output": "src"
+  "output": "app/lib"
 }
@@ -38,12 +38,13 @@ ```
 my_project/
-├─ src/
-│  ├─ petstore/
-│  │  ├─ v1/
-│  │  │  ├─ some_enum_a.rb
-│  │  │  ├─ some_enum_b.rb
-│  │  │  ├─ some_interface_a.rb
-│  │  │  ├─ some_interface_b.rb
-│  │  │  ├─ some_type_a.rb
-│  │  │  ├─ some_type_b.rb
-│  ├─ .gitattributes
+├─ app/
+│  ├─ lib/
+│  │  ├─ petstore/
+│  │  │  ├─ v1/
+│  │  │  │  ├─ some_enum_a.rb
+│  │  │  │  ├─ some_enum_b.rb
+│  │  │  │  ├─ some_interface_a.rb
+│  │  │  │  ├─ some_interface_b.rb
+│  │  │  │  ├─ some_type_a.rb
+│  │  │  │  ├─ some_type_b.rb
+│  │  ├─ .gitattributes
 ├─ basketry.config.json
@@ -77,3 +78,3 @@ ├─ petstore.json
   ],
-  "output": "src"
+  "output": "app/lib"
 }
@@ -103,11 +104,12 @@ ```
 my_project/
-├─ src/
-│  ├─ petstore/
-│  │  ├─ some_enum_a.rb
-│  │  ├─ some_enum_b.rb
-│  │  ├─ some_interface_a.rb
-│  │  ├─ some_interface_b.rb
-│  │  ├─ some_type_a.rb
-│  │  ├─ some_type_b.rb
-│  ├─ .gitattributes
+├─ app/
+│  ├─ lib/
+│  │  ├─ petstore/
+│  │  │  ├─ some_enum_a.rb
+│  │  │  ├─ some_enum_b.rb
+│  │  │  ├─ some_interface_a.rb
+│  │  │  ├─ some_interface_b.rb
+│  │  │  ├─ some_type_a.rb
+│  │  │  ├─ some_type_b.rb
+│  │  ├─ .gitattributes
 ├─ basketry.config.json
@@ -136,13 +138,14 @@ ├─ petstore.json
 my_project/
-├─ src/
-│  ├─ petstore/
-│  │  ├─ v1/
-│  │  │  ├─ types/
-│  │  │  │  ├─ some_type_a.rb
-│  │  │  │  ├─ some_type_b.rb
-│  │  │  ├─ some_enum_a.rb
-│  │  │  ├─ some_enum_b.rb
-│  │  │  ├─ some_interface_a.rb
-│  │  │  ├─ some_interface_b.rb
-│  ├─ .gitattributes
+├─ app/
+│  ├─ lib/
+│  │  ├─ petstore/
+│  │  │  ├─ v1/
+│  │  │  │  ├─ types/
+│  │  │  │  │  ├─ some_type_a.rb
+│  │  │  │  │  ├─ some_type_b.rb
+│  │  │  │  ├─ some_enum_a.rb
+│  │  │  │  ├─ some_enum_b.rb
+│  │  │  │  ├─ some_interface_a.rb
+│  │  │  │  ├─ some_interface_b.rb
+│  │  ├─ .gitattributes
 ├─ basketry.config.json
@@ -171,13 +174,14 @@ ├─ petstore.json
 my_project/
-├─ src/
-│  ├─ petstore/
-│  │  ├─ v1/
-│  │  │  ├─ enums/
-│  │  │  │  ├─ some_enum_a.rb
-│  │  │  │  ├─ some_enum_b.rb
-│  │  │  ├─ some_interface_a.rb
-│  │  │  ├─ some_interface_b.rb
-│  │  │  ├─ some_type_a.rb
-│  │  │  ├─ some_type_b.rb
-│  ├─ .gitattributes
+├─ app/
+│  ├─ lib/
+│  │  ├─ petstore/
+│  │  │  ├─ v1/
+│  │  │  │  ├─ enums/
+│  │  │  │  │  ├─ some_enum_a.rb
+│  │  │  │  │  ├─ some_enum_b.rb
+│  │  │  │  ├─ some_interface_a.rb
+│  │  │  │  ├─ some_interface_b.rb
+│  │  │  │  ├─ some_type_a.rb
+│  │  │  │  ├─ some_type_b.rb
+│  │  ├─ .gitattributes
 ├─ basketry.config.json
@@ -206,13 +210,14 @@ ├─ petstore.json
 my_project/
-├─ src/
-│  ├─ petstore/
-│  │  ├─ v1/
-│  │  │  ├─ services/
-│  │  │  │  ├─ some_interface_a.rb
-│  │  │  │  ├─ some_interface_b.rb
-│  │  │  ├─ some_enum_a.rb
-│  │  │  ├─ some_enum_b.rb
-│  │  │  ├─ some_type_a.rb
-│  │  │  ├─ some_type_b.rb
-│  ├─ .gitattributes
+├─ app/
+│  ├─ lib/
+│  │  ├─ petstore/
+│  │  │  ├─ v1/
+│  │  │  │  ├─ services/
+│  │  │  │  │  ├─ some_interface_a.rb
+│  │  │  │  │  ├─ some_interface_b.rb
+│  │  │  │  ├─ some_enum_a.rb
+│  │  │  │  ├─ some_enum_b.rb
+│  │  │  │  ├─ some_type_a.rb
+│  │  │  │  ├─ some_type_b.rb
+│  │  ├─ .gitattributes
 ├─ basketry.config.json
@@ -222,2 +227,17 @@ ├─ petstore.json
 
+### `magicComments`
+
+This option allows you to add magic comments to the files emitted by this generator.
+
+```json
+{
+  "rule": "@basketry/sorbet",
+  "options": {
+    "sorbet": {
+      "magicComments": ["frozen_string_literal: true"]
+    }
+  }
+}
+```
+
 ### `types`
@@ -224,0 +244,0 @@

No alert changes

Improved metrics

Total package byte prevSize

45201

increased by3.61%

Lines of code

478

increased by2.8%

Number of lines in readme file

287

increased by7.49%

No dependency changes