Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a top-level .gitignore #1383

Merged
merged 4 commits into from
Aug 19, 2024
Merged

Add a top-level .gitignore #1383

merged 4 commits into from
Aug 19, 2024

Conversation

HosseinYousefi
Copy link
Member

@HosseinYousefi HosseinYousefi commented Jul 31, 2024 •
edited
Loading

Removed remaining pubspec.locks.
Copied the .gitignore from https://github.com/flutter/packages/blob/main/.gitignore.
Removed extra .gitignore files.

Motivation: it does not make sense to have pubspec.lock, but example's default .gitignore does not ignore it as it's technically an application not a package.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 31, 2024 •
edited
Loading

PR Health

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

Coverage ✔️
File Coverage

This check for test coverage is informational (issues shown here will not fail the PR).

License Headers ✔️ 
// Copyright (c) 2024, 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.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/ffigen/example/libclang-example/generated_bindings.dart
pkgs/ffigen/example/shared_bindings/generate.dart
pkgs/ffigen/example/shared_bindings/lib/generated/a_gen.dart
pkgs/ffigen/example/shared_bindings/lib/generated/a_shared_b_gen.dart
pkgs/ffigen/example/shared_bindings/lib/generated/base_gen.dart
pkgs/ffigen/example/simple/generated_bindings.dart
pkgs/ffigen/lib/src/header_parser/clang_bindings/clang_bindings.dart
pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_decl_collision_bindings.dart
pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_symbol_address_collision_bindings.dart
pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_type_name_collision_bindings.dart
pkgs/ffigen/test/collision_tests/expected_bindings/_expected_reserved_keyword_collision_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_comment_markup_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_dart_handle_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_enum_int_mimic_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_forward_decl_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_functions_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_imported_types_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_native_func_typedef_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_opaque_dependencies_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_packed_structs_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_regress_384_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_struct_fptr_fields_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_typedef_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_unions_bindings.dart
pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_varargs_bindings.dart
pkgs/ffigen/test/large_integration_tests/_expected_cjson_bindings.dart
pkgs/ffigen/test/large_integration_tests/_expected_libclang_bindings.dart
pkgs/ffigen/test/large_integration_tests/_expected_sqlite_bindings.dart
pkgs/ffigen/test/native_test/_expected_native_test_bindings.dart
pkgs/jni/lib/src/lang/jcharacter.dart
pkgs/jni/lib/src/third_party/generated_bindings.dart
pkgs/jni/lib/src/third_party/global_env_extensions.dart
pkgs/jni/lib/src/third_party/jni_bindings_generated.dart
pkgs/jnigen/android_test_runner/lib/main.dart
pkgs/jnigen/example/in_app_java/lib/android_utils.dart
pkgs/jnigen/example/kotlin_plugin/example/lib/main.dart
pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart
pkgs/jnigen/example/kotlin_plugin/lib/kotlin_plugin.dart
pkgs/jnigen/example/pdfbox_plugin/lib/pdfbox_plugin.dart
pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart
pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart
pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/_package.dart
pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart
pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/_package.dart
pkgs/jnigen/lib/src/bindings/descriptor.dart
pkgs/jnigen/lib/src/elements/elements.g.dart
pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/_package.dart
pkgs/jnigen/tool/command_runner.dart
pkgs/swift2objc/lib/src/config.dart
pkgs/swift2objc/lib/src/generate_wrapper.dart
pkgs/swift2objc/lib/src/generator/_core/utils.dart
pkgs/swift2objc/lib/src/generator/generator.dart
pkgs/swift2objc/lib/src/generator/generators/class_generator.dart
pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_property_declaration.dart
pkgs/swift2objc/lib/src/transformer/_core/unique_namer.dart
pkgs/swift2objc/lib/src/transformer/_core/utils.dart
pkgs/swift2objc/lib/src/transformer/transformers/transform_property.dart
Package publish validation ❗
Package Version Status
package:ffi 2.1.3 already published at pub.dev
package:ffigen 14.0.0-wip WIP (no publish necessary)
package:jni 0.11.0-wip WIP (no publish necessary)
package:native_assets_cli 0.7.3-wip WIP (no publish necessary)
package:objective_c 1.2.0-wip WIP (no publish necessary)
package:swift2objc 0.0.1-wip WIP (no publish necessary)
package:swiftgen 0.0.1-wip WIP (no publish necessary)
package:jnigen 0.10.1 (error) pub publish dry-run failed; add the publish-ignore-warnings label to ignore

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

This check can be disabled by tagging the PR with skip-version-check.

@coveralls
Copy link

coveralls commented Jul 31, 2024 •
edited
Loading

Coverage Status

coverage: 91.918%. remained the same
when pulling c084c11 on unify-gitignores
into 09a32e4 on main.

@dcharkes
Copy link
Collaborator

There are many .gitignores in this repo, it doesn't look very clean if some files are gitignored at multiple directory levels.

Should we also remove all nested gitignores? (Or at least remove all entries that are overlapping with the toplevel one?)

And what about gitignores in examples and test projects which are likely to be verbatim copied. Should we update those to be whatever is currently the standard in flutter / dart templates?

@HosseinYousefi
Copy link
Member Author

Agreed. I'll do that in the next commit.

@dcharkes
Copy link
Collaborator

commit.

Commit or PR?

@HosseinYousefi
Copy link
Member Author

commit.

Commit or PR?

Commit on the same PR.

@HosseinYousefi HosseinYousefi marked this pull request as draft July 31, 2024 13:37
@HosseinYousefi HosseinYousefi marked this pull request as ready for review July 31, 2024 15:40
@HosseinYousefi
Copy link
Member Author

@dcharkes I removed the redundant .gitignores. PTAL.

Will address jnigen CI in a future PR – #1385

@dcharkes dcharkes requested a review from mosuem July 31, 2024 16:29
@dcharkes
Copy link
Collaborator

@mosuem Any guidance from an ecosystem perspective on how to structure gitignores in mono repos and in example projects?

@mosuem
Copy link
Member

mosuem commented Aug 1, 2024

Any guidance from an ecosystem perspective on how to structure gitignores in mono repos and in example projects?

No. I personally would use a top-level .gitignore for general stuff, and lower-level for specific files. But I suspect there aren't many false positives even with broad ignore rules, as they will target specific file extensions for the most part.

@github-actions github-actions bot added the type-infra A repository infrastructure change or enhancement label Aug 19, 2024
@github-actions github-actions bot removed the type-infra A repository infrastructure change or enhancement label Aug 19, 2024
@HosseinYousefi HosseinYousefi marked this pull request as draft August 19, 2024 14:32
@HosseinYousefi HosseinYousefi marked this pull request as ready for review August 19, 2024 14:51
@HosseinYousefi
Copy link
Member Author

@dcharkes @mosuem Please take another look. This only changes the .gitignore files, the CI redness should not be related to this PR. I want to merge this now that I'm back.

@HosseinYousefi
Copy link
Member Author

Merging as the only files changed are .gitignores.

@HosseinYousefi HosseinYousefi merged commit 4a18bf2 into main Aug 19, 2024
55 of 63 checks passed
@HosseinYousefi HosseinYousefi deleted the unify-gitignores branch August 19, 2024 15:03
@dcharkes dcharkes mentioned this pull request Sep 2, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dcharkes dcharkes dcharkes approved these changes

@mosuem mosuem Awaiting requested review from mosuem

Assignees
No one assigned
Labels
package:ffigen package:jni package:jnigen package:native_assets_builder package:native_assets_cli package:native_toolchain_c package:objective_c package:swiftgen
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@HosseinYousefi @coveralls @dcharkes @mosuem