Initial commit

.github/workflows/go.yml

@@ -0,0 +1,53 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    defaults:
+      run:
+        working-directory: ./tool
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+
+    - name: Set up Dart
+      uses: dart-lang/setup-dart@v1
+
+    - name: pub get on fixtures
+      run: (cd ./generation_test/fixtures && dart pub get)
+
+    - name: Build
+      run: go build -v ./...
+
+    - name: Test
+      run: go test -v ./...
+  test-generated:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./packages/genq_test
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+    - name: Set up Dart
+      uses: dart-lang/setup-dart@v1
+    - name: pub get
+      run: dart pub get
+    - name: run_tests.sh
+      run: ./run_tests.sh

.github/workflows/tag.yml

@@ -0,0 +1,42 @@
+# .github/workflows/release.yml
+name: goreleaser
+
+on:
+  pull_request:
+  push:
+    # run only against tags
+    tags:
+      - "*"
+
+permissions:
+  contents: write
+  # packages: write
+  # issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      # More assembly might be required: Docker logins, GPG, etc.
+      # It all depends on your needs.
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          # either 'goreleaser' (default) or 'goreleaser-pro'
+          distribution: goreleaser
+          version: latest
+          args: release --clean
+          workdir: ./tool
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_BREW: ${{ secrets.GH_BREW }}
+          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro' distribution
+          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jan Kuß ([email protected])
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,80 @@
+# genq: Blazing Fast Data Class Generation for Dart
+
+![](./docs/preview.gif)
+
+**Tired of waiting for build_runner to churn through your codebase?**
+
+genq cuts through the wait and generates data classes for your Dart projects in seconds, not minutes. ⚡️
+
+Inspired by **freezed**, genq offers a familiar syntax for defining data classes, but with a focus on **lightning-fast performance**. No need to write copyWith, toString, or equals methods by hand - genq does it all for you.
+
+**Here's what genq brings to the table:**
+
+* **Reduce Boilerplate:** genq generates the boilerplate code for you, so you can focus on what matters:
+    * **copyWith:** Create copies of your data classes with modified fields.
+    * **toString:** Generate human-readable string representations of your data classes.
+    * **==**: Compare data classes for equality.
+* **Speed Demon:** Generate data classes in a flash, even for large projects.
+* **Simple and Familiar:** Syntax similar to freezed, making it easy to learn and use.
+
+## `genq` vs `build_runner` + `freezed`
+
+`build_runner` + `freezed` 🐌 | `genq` 🚀
+:-------------------------:|:-------------------------:
+![build_runner](./docs/freezed.png) | ![genq](./docs/genq.png)
+
+In this benchmark (located in `./benchmarks`), _count_ is the number of files in the benchmark, containing 250 annotated classes each. So for example, _count=1_ means 250 classes, _count=2_ means 500 classes, and so on. For count 10, `build_runner` and `freezed` took around 46 seconds, while `genq` took 0.11 seconds. **This is a >400x speedup!**
+
+#### Notes
+
+1. Never trust a benchmark you didn't falsify yourself.
+2. genq is optimized to perform one task and one task only - data class generation, whereas build_runner is built to do a lot more. Take this into account when choosing between the two.
+
+## Getting started is easy
+
+### 1. Install
+
+Install genq via brew using the following command:
+
+```
+brew install jankuss/genq/genq
+```
+
+Or download the latest release from the [releases page](https://github.com/jankuss/genq/releases).
+
+### 2. Add `genq` to your project
+
+```
+dependencies:
+  # ... Other dependencies ...
+  genq: ^0.2.0
+```
+
+### 3. Define your data classes
+
+```dart
+import 'package:genq/genq.dart';
+
+part 'user.genq.dart';
+
+@genq
+class User with _$User {
+  factory User({
+    required String name,
+    required int age,
+  }) = _User;
+}
+```
+
+### 4. Generate the code
+
+Run the genq command in your project directory, and you will have your desired data classes generated in no time:
+
+```
+genq
+```
+
+## Future Plans
+
+- [ ] JSON Serialization/Deserialization
+- [ ] Extensibility

benchmarks/freezed_benchmark/.gitignore

@@ -0,0 +1,45 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
+
+/lib/gen

benchmarks/freezed_benchmark/.metadata

@@ -0,0 +1,45 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "2e9cb0aa71a386a91f73f7088d115c0d96654829"
+  channel: "[user-branch]"
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+    - platform: android
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+    - platform: ios
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+    - platform: linux
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+    - platform: macos
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+    - platform: web
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+    - platform: windows
+      create_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+      base_revision: 2e9cb0aa71a386a91f73f7088d115c0d96654829
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

benchmarks/freezed_benchmark/README.md

@@ -0,0 +1,16 @@
+# freezed_benchmark
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+
+For help getting started with Flutter development, view the
+[online documentation](https://docs.flutter.dev/), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

benchmarks/freezed_benchmark/analysis_options.yaml

@@ -0,0 +1,28 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at https://dart.dev/lints.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

benchmarks/freezed_benchmark/android/.gitignore

@@ -0,0 +1,13 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks