Merge pull request #404 from dart-lang/merge-platform-package

Merge `package:platform`

.github/ISSUE_TEMPLATE/platform.md

@@ -0,0 +1,5 @@
+---
+name: "package:platform"
+about: "Create a bug or file a feature request against package:platform."
+labels: "package:platform"
+---

.github/labeler.yml

@@ -35,3 +35,7 @@
 "package:path":
   - changed-files:
       - any-glob-to-any-file: 'pkgs/path/**'
+
+"package:platform":
+  - changed-files:
+      - any-glob-to-any-file: 'pkgs/platform/**'

.github/workflows/health.yaml

@@ -9,6 +9,6 @@ jobs:
     uses: dart-lang/ecosystem/.github/workflows/health.yaml@main
     with:
       ignore_coverage: "**.mock.dart,**.g.dart"
-      ignore_license: "**.mock.dart,**.g.dart,**.mocks.dart"
+      ignore_license: "**.mock.dart,**.g.dart,**.mocks.dart,pkgs/platform/*"
     permissions:
       pull-requests: write

.github/workflows/platform.yaml

@@ -0,0 +1,52 @@
+name: package:platform
+
+on:
+  # Run CI on pushes to the main branch, and on PRs against main.
+  push:
+    branches: [ main ]
+    paths:
+      - '.github/workflows/platform.yaml'
+      - 'pkgs/platform/**'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - '.github/workflows/platform.yaml'
+      - 'pkgs/platform/**'
+  schedule:
+    - cron: "0 0 * * 0"
+env:
+  PUB_ENVIRONMENT: bot.github
+
+defaults:
+  run:
+    working-directory: pkgs/platform/
+
+jobs:
+  correctness:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - uses: dart-lang/setup-dart@9a04e6d73cca37bd455e0608d7e5092f881fd603
+        with:
+          sdk: dev
+      - name: Install dependencies
+        run: dart pub upgrade
+      - name: Verify formatting
+        run: dart format --output=none --set-exit-if-changed .
+      - name: Analyze project source
+        run: dart analyze --fatal-infos
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        sdk: [stable, beta, dev]
+    steps:
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - uses: dart-lang/setup-dart@9a04e6d73cca37bd455e0608d7e5092f881fd603
+        with:
+          sdk: ${{ matrix.sdk }}
+      - name: Install dependencies
+        run: dart pub upgrade
+      - name: Run Tests
+        run: dart test

README.md

@@ -17,6 +17,7 @@ This repository is home to various Dart packages under the [dart.dev](https://pu
 | [logging](pkgs/logging/) | Provides APIs for debugging and error logging. | [![pub package](https://img.shields.io/pub/v/logging.svg)](https://pub.dev/packages/logging) |
 | [os_detect](pkgs/os_detect/) | Platform independent OS detection. | [![pub package](https://img.shields.io/pub/v/os_detect.svg)](https://pub.dev/packages/os_detect) |
 | [path](pkgs/path/) | A string-based path manipulation library for all of the path operations you know and love. | [![pub package](https://img.shields.io/pub/v/path.svg)](https://pub.dev/packages/path) |
+| [platform](pkgs/platform/) | A pluggable, mockable platform information abstraction for Dart. | [![pub package](https://img.shields.io/pub/v/platform.svg)](https://pub.dev/packages/platform) |
 
 ## Publishing automation
 

pkgs/platform/.gitignore

@@ -0,0 +1,17 @@
+### Dart template
+# Don’t commit the following directories created by pub.
+.buildlog
+.dart_tool/
+.pub/
+build/
+packages
+.packages
+
+# Include when developing application packages.
+pubspec.lock
+
+# IDE
+.project
+.settings
+.idea
+.c9

pkgs/platform/AUTHORS

@@ -0,0 +1,6 @@
+# Below is a list of people and organizations that have contributed
+# to the Process project. Names should be added to the list like so:
+#
+#   Name/Organization <email address>
+
+Google Inc.

pkgs/platform/CHANGELOG.md

@@ -0,0 +1,111 @@
+## 3.1.6
+
+* Move to `dart-lang/core` monorepo.
+
+## 3.1.5
+
+* Updates minimum supported SDK version to Flutter 3.16/Dart 3.2.
+* Transfers the package source from https://github.com/flutter/packages
+  to https://github.com/dart-lang/platform.
+
+## 3.1.4
+
+* Updates minimum supported SDK version to Flutter 3.10/Dart 3.0.
+* Fixes new lint warnings.
+
+## 3.1.3
+
+* Adds example app.
+
+## 3.1.2
+
+* Adds pub topics to package metadata.
+* Updates minimum supported SDK version to Flutter 3.7/Dart 2.19.
+
+## 3.1.1
+
+* Transfers the package source from https://github.com/google/platform.dart to
+  https://github.com/flutter/packages.
+
+## 3.1.0
+
+* Removed `Platform.packageRoot`, which was already marked deprecated, and which
+  didn't work in Dart 2.
+
+## 3.0.2
+
+* Added `FakePlatform.copyWith` function.
+
+## 3.0.1
+
+* Added string constants for each of the supported platforms for use in switch
+  statements.
+
+## 3.0.0
+
+* First stable null safe release.
+
+## 3.0.0-nullsafety.4
+
+* Update supported SDK range.
+
+## 3.0.0-nullsafety.3
+
+* Update supported SDK range.
+
+## 3.0.0-nullsafety.2
+
+* Update supported SDK range.
+
+## 3.0.0-nullsafety.1
+
+* Migrate package to null-safe dart.
+
+## 2.2.1
+
+* Add `operatingSystemVersion`
+
+## 2.2.0
+
+* Declare compatibility with Dart 2 stable
+* Update dependency on `package:test` to 1.0
+
+## 2.1.2
+
+* Relax sdk upper bound constraint to  '<2.0.0' to allow 'edge' dart sdk use.
+
+## 2.1.1
+
+* Bumped maximum Dart SDK version to 2.0.0-dev.infinity
+
+## 2.1.0
+
+* Added `localeName`
+* Bumped minimum Dart SDK version to 1.24.0-dev.0.0
+
+## 2.0.0
+
+* Added `stdinSupportsAnsi` and `stdinSupportsAnsi`
+* Removed `ansiSupported`
+
+## 1.1.1
+
+* Updated `LocalPlatform` to use new `dart.io` API for ansi color support queries
+* Bumped minimum Dart SDK version to 1.23.0-dev.10.0
+
+## 1.1.0
+
+* Added `ansiSupported`
+* Bumped minimum Dart SDK version to 1.23.0-dev.9.0
+
+## 1.0.2
+
+* Minor doc updates
+
+## 1.0.1
+
+* Added const constructors for `Platform` and `LocalPlatform`
+
+## 1.0.0
+
+* Initial version

pkgs/platform/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2017, the Dart project authors. All rights reserved.
+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 Inc. 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.

pkgs/platform/README.md

@@ -0,0 +1,10 @@
+[![Pub](https://img.shields.io/pub/v/platform.svg)](https://pub.dartlang.org/packages/platform)
+
+A generic platform abstraction for Dart.
+
+Like `dart:io`, `package:platform` supplies a rich, Dart-idiomatic API for
+accessing platform-specific information.
+
+`package:platform` provides a lightweight wrapper around the static `Platform`
+properties that exist in `dart:io`. However, it uses instance properties rather
+than static properties, making it possible to mock out in tests.

pkgs/platform/analysis_options.yaml

@@ -0,0 +1,6 @@
+include: package:dart_flutter_team_lints/analysis_options.yaml
+
+analyzer:
+  errors:
+    # Allow having TODOs in the code
+    todo: ignore

pkgs/platform/example/.gitignore

@@ -0,0 +1,3 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/

pkgs/platform/example/README.md

@@ -0,0 +1,2 @@
+A small example application demonstrating how to use the platform information
+APIs in `package:platform`.

pkgs/platform/example/analysis_options.yaml

@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

pkgs/platform/example/bin/example.dart

@@ -0,0 +1,15 @@
+import 'package:platform/platform.dart';
+
+void main(List<String> arguments) {
+  const LocalPlatform platform = LocalPlatform();
+
+  print('Operating System: ${platform.operatingSystem}.');
+  print('Local Hostname: ${platform.localHostname}.');
+  print('Number of Processors: ${platform.numberOfProcessors}.');
+  print('Path Separator: ${platform.pathSeparator}.');
+  print('Locale Name: ${platform.localeName}.');
+  print('Stdin Supports ANSI: ${platform.stdinSupportsAnsi}.');
+  print('Stdout Supports ANSI: ${platform.stdoutSupportsAnsi}.');
+  print('Executable Arguments: ${platform.executableArguments}.');
+  print('Dart Version: ${platform.version}.');
+}

pkgs/platform/example/pubspec.yaml

@@ -0,0 +1,14 @@
+name: example
+description: Demonstrates how to use the platform api.
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: ^3.2.0
+
+dependencies:
+  platform:
+    path: ../
+
+dev_dependencies:
+  lints: ^4.0.0

pkgs/platform/lib/platform.dart

@@ -0,0 +1,8 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// Core interfaces & classes.
+export 'src/interface/local_platform.dart';
+export 'src/interface/platform.dart';
+export 'src/testing/fake_platform.dart';