[native_doc_dartifier] Add initial skeleton (#2304)

HosseinYousefi · web-flow · commit 3349a78aea11 · 2025-05-16T11:44:15.000+02:00
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -36,6 +36,10 @@
   - changed-files:
     - any-glob-to-any-file: 'pkgs/hooks_runner/**'
 
+'package:native_doc_dartifier':
+  - changed-files:
+    - any-glob-to-any-file: 'pkgs/native_doc_dartifier/**'
+
 'package:native_toolchain_c':
   - changed-files:
     - any-glob-to-any-file: 'pkgs/native_toolchain_c/**'
diff --git a/.github/pr-title-checker-config.json b/.github/pr-title-checker-config.json
@@ -10,6 +10,7 @@
             "[infra] ",
             "[jni] ",
             "[jnigen] ",
+            "[native_doc_dartifier] ",
             "[native_toolchain_c] ",
             "[objective_c] ",
             "[swift2objc] ",
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ building and bundling.
 | [hooks_runner](pkgs/hooks_runner/) | This package is the backend that invokes `hook/build.dart` and `hook/link.dart` from Dart and Flutter. | [![issues](https://img.shields.io/badge/package:hooks__runner-4774bc)][hooks_runner_issues] |  |
 | [jni](pkgs/jni/) | A library to access JNI from Dart and Flutter that acts as a support library for package:jnigen. | [![issues](https://img.shields.io/badge/package:jni-4774bc)][jni_issues] | [![pub package](https://img.shields.io/pub/v/jni.svg)](https://pub.dev/packages/jni) |
 | [jnigen](pkgs/jnigen/) | A Dart bindings generator for Java and Kotlin that uses JNI under the hood to interop with Java virtual machine. | [![issues](https://img.shields.io/badge/package:jnigen-4774bc)][jnigen_issues] | [![pub package](https://img.shields.io/pub/v/jnigen.svg)](https://pub.dev/packages/jnigen) |
+| [native_doc_dartifier](pkgs/native_doc_dartifier/) | A library that converts code snippets from other languages into Dart. | [![issues](https://img.shields.io/badge/package:native__doc__dartifier-4774bc)](native_doc_dartifier_issues) | [![pub package](https://img.shields.io/pub/v/native_doc_dartifier.svg)](https://pub.dev/packages/native_doc_dartifier) |
 | [native_toolchain_c](pkgs/native_toolchain_c/) | A library to invoke the native C compiler installed on the host machine. | [![issues](https://img.shields.io/badge/package:native__toolchain__c-4774bc)][native_toolchain_c_issues] |  |
 | [objective_c](pkgs/objective_c/) | A library to access Objective C from Flutter that acts as a support library for package:ffigen. | [![issues](https://img.shields.io/badge/package:objective__c-4774bc)][objective_c_issues] | [![pub package](https://img.shields.io/pub/v/objective_c.svg)](https://pub.dev/packages/objective_c) |
 | [swift2objc](pkgs/swift2objc/) | A tool for generating bindings that allow interop between Dart and Swift code. | [![issues](https://img.shields.io/badge/package:swift2objc-4774bc)][swift2objc_issues] | [![pub package](https://img.shields.io/pub/v/swift2objc.svg)](https://pub.dev/packages/swift2objc) |
diff --git a/pkgs/native_doc_dartifier/.gitignore b/pkgs/native_doc_dartifier/.gitignore
@@ -0,0 +1,7 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# Avoid committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
diff --git a/pkgs/native_doc_dartifier/CHANGELOG.md b/pkgs/native_doc_dartifier/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1-pre
+
+- Initial version.
diff --git a/pkgs/native_doc_dartifier/LICENSE b/pkgs/native_doc_dartifier/LICENSE
@@ -0,0 +1,27 @@
+Copyright 2025, the Dart project authors.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of Google LLC nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/pkgs/native_doc_dartifier/README.md b/pkgs/native_doc_dartifier/README.md
@@ -0,0 +1 @@
+# Native Doc Dartifier
diff --git a/pkgs/native_doc_dartifier/analysis_options.yaml b/pkgs/native_doc_dartifier/analysis_options.yaml
@@ -0,0 +1,17 @@
+include: package:dart_flutter_team_lints/analysis_options.yaml
+
+analyzer:
+  errors:
+    todo: ignore
+  language:
+    strict-casts: true
+    strict-inference: true
+    strict-raw-types: true
+
+linter:
+  rules:
+    - dangling_library_doc_comments
+    - prefer_const_declarations
+    - prefer_expression_function_bodies
+    - prefer_final_in_for_each
+    - prefer_final_locals
diff --git a/pkgs/native_doc_dartifier/example/native_doc_dartifier_example.dart b/pkgs/native_doc_dartifier/example/native_doc_dartifier_example.dart
@@ -0,0 +1,6 @@
+import 'package:native_doc_dartifier/native_doc_dartifier.dart';
+
+void main() {
+  var awesome = Awesome();
+  print('awesome: ${awesome.isAwesome}');
+}
diff --git a/pkgs/native_doc_dartifier/lib/native_doc_dartifier.dart b/pkgs/native_doc_dartifier/lib/native_doc_dartifier.dart
@@ -0,0 +1,8 @@
+/// Support for doing something awesome.
+///
+/// More dartdocs go here.
+library;
+
+export 'src/native_doc_dartifier_base.dart';
+
+// TODO: Export any libraries intended for clients of this package.
diff --git a/pkgs/native_doc_dartifier/lib/src/native_doc_dartifier_base.dart b/pkgs/native_doc_dartifier/lib/src/native_doc_dartifier_base.dart
@@ -0,0 +1,6 @@
+// TODO: Put public facing types in this file.
+
+/// Checks if you are awesome. Spoiler: you are.
+class Awesome {
+  bool get isAwesome => true;
+}
diff --git a/pkgs/native_doc_dartifier/pubspec.yaml b/pkgs/native_doc_dartifier/pubspec.yaml
@@ -0,0 +1,16 @@
+name: native_doc_dartifier
+description: A library that converts code snippets from other languages into Dart
+version: 0.0.1-pre
+repository: https://github.com/dart-lang/native/tree/main/pkgs/native_doc_dartifier
+issue_tracker: https://github.com/dart-lang/native/issues?q=is%3Aopen+label%3Apackage%3Anative_doc_dartifier
+
+environment:
+  sdk: '>=3.7.0 <4.0.0'
+
+# Add regular dependencies here.
+dependencies:
+  # path: ^1.8.0
+
+dev_dependencies:
+  dart_flutter_team_lints: ^3.5.1
+  test: ^1.26.0
diff --git a/pkgs/native_doc_dartifier/test/native_doc_dartifier_test.dart b/pkgs/native_doc_dartifier/test/native_doc_dartifier_test.dart
@@ -0,0 +1,16 @@
+import 'package:native_doc_dartifier/native_doc_dartifier.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('A group of tests', () {
+    final awesome = Awesome();
+
+    setUp(() {
+      // Additional setup goes here.
+    });
+
+    test('First Test', () {
+      expect(awesome.isAwesome, isTrue);
+    });
+  });
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 0.0.1-pre`
	`2`	`+`
	`3`	`+- Initial version.`