Skip to content

Commit

Permalink
Merge package:platform into the core monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
mosuem committed Oct 16, 2024
2 parents 279afbc + 5b429af commit da40958
Show file tree
Hide file tree
Showing 20 changed files with 969 additions and 0 deletions.
38 changes: 38 additions & 0 deletions pkgs/platform/.github/workflows/platform.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Platform Package

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
workflow_dispatch:

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
17 changes: 17 additions & 0 deletions pkgs/platform/.gitignore
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions pkgs/platform/AUTHORS
Original file line number Diff line number Diff line change
@@ -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.
107 changes: 107 additions & 0 deletions pkgs/platform/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
## 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
24 changes: 24 additions & 0 deletions pkgs/platform/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# How to contribute

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution,
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.

## Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult [GitHub Help] for more
information on using pull requests.

[GitHub Help]: https://help.github.com/articles/about-pull-requests/
26 changes: 26 additions & 0 deletions pkgs/platform/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions pkgs/platform/README.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 6 additions & 0 deletions pkgs/platform/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
include: package:dart_flutter_team_lints/analysis_options.yaml

analyzer:
errors:
# Allow having TODOs in the code
todo: ignore
3 changes: 3 additions & 0 deletions pkgs/platform/example/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# https://dart.dev/guides/libraries/private-files
# Created by `dart pub`
.dart_tool/
2 changes: 2 additions & 0 deletions pkgs/platform/example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
A small example application demonstrating how to use the platform information
APIs in `package:platform`.
30 changes: 30 additions & 0 deletions pkgs/platform/example/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions pkgs/platform/example/bin/example.dart
Original file line number Diff line number Diff line change
@@ -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}.');
}
14 changes: 14 additions & 0 deletions pkgs/platform/example/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions pkgs/platform/lib/platform.dart
Original file line number Diff line number Diff line change
@@ -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';
58 changes: 58 additions & 0 deletions pkgs/platform/lib/src/interface/local_platform.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
// 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.

import 'dart:io' as io show Platform, stdin, stdout;

import 'platform.dart';

/// `Platform` implementation that delegates directly to `dart:io`.
class LocalPlatform extends Platform {
/// Creates a new [LocalPlatform].
const LocalPlatform();

@override
int get numberOfProcessors => io.Platform.numberOfProcessors;

@override
String get pathSeparator => io.Platform.pathSeparator;

@override
String get operatingSystem => io.Platform.operatingSystem;

@override
String get operatingSystemVersion => io.Platform.operatingSystemVersion;

@override
String get localHostname => io.Platform.localHostname;

@override
Map<String, String> get environment => io.Platform.environment;

@override
String get executable => io.Platform.executable;

@override
String get resolvedExecutable => io.Platform.resolvedExecutable;

@override
Uri get script => io.Platform.script;

@override
List<String> get executableArguments => io.Platform.executableArguments;

@override
String? get packageConfig => io.Platform.packageConfig;

@override
String get version => io.Platform.version;

@override
bool get stdinSupportsAnsi => io.stdin.supportsAnsiEscapes;

@override
bool get stdoutSupportsAnsi => io.stdout.supportsAnsiEscapes;

@override
String get localeName => io.Platform.localeName;
}
Loading

0 comments on commit da40958

Please sign in to comment.