Skip to content

Commit

Permalink
fix: some maintaining work (#129)
Browse files Browse the repository at this point in the history
* fix: add creation install script

* fix: format vscode settings

* fix: format code
  • Loading branch information
tianhaoz95 authored Jun 1, 2021
1 parent 2335dac commit b3f8fdc
Show file tree
Hide file tree
Showing 27 changed files with 195 additions and 178 deletions.
74 changes: 31 additions & 43 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,46 +1,34 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.166.1/containers/ruby
{
"name": "Ruby",
"build": {
"dockerfile": "Dockerfile",
"args": {
// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6, 2.5
"VARIANT": "2.7",
// Options
"INSTALL_NODE": "true",
"NODE_VERSION": "lts/*"
}
},

// Set *default* container specific settings.json values on container create.
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},

// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"rebornix.Ruby",
"rebornix.ruby",
"github.vscode-codeql",
"docsmsft.docs-markdown",
"donjayamanne.githistory",
"ms-vscode.github-issues-prs",
"github.vscode-pull-request-github",
"eamodio.gitlens",
"ms-vsliveshare.vsliveshare-pack",
"davidanson.vscode-markdownlint",
"visualstudioexptteam.vscodeintellicode",
"redhat.vscode-yaml"
],

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "ruby --version",

// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode"

}
"name": "Ruby",
"build": {
"dockerfile": "Dockerfile",
"args": {
"VARIANT": "2.7",
"INSTALL_NODE": "true",
"NODE_VERSION": "lts/*"
}
},
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
"extensions": [
"rebornix.Ruby",
"rebornix.ruby",
"github.vscode-codeql",
"docsmsft.docs-markdown",
"donjayamanne.githistory",
"ms-vscode.github-issues-prs",
"github.vscode-pull-request-github",
"eamodio.gitlens",
"ms-vsliveshare.vsliveshare-pack",
"davidanson.vscode-markdownlint",
"visualstudioexptteam.vscodeintellicode",
"redhat.vscode-yaml",
"esbenp.prettier-vscode"
],
"postCreateCommand": "ruby --version",
"remoteUser": "vscode",
"postStartCommand": "bundle install"
}
20 changes: 11 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand All @@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Feature request
about: Suggest an idea for this project
title: "[FEAT]"
labels: feature
assignees: ''

assignees: ""
---

**Is your feature request related to a problem? Please describe.**
Expand Down
2 changes: 1 addition & 1 deletion .github/approveman.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ ownership_rules:
- name: personal projects in experimental
path: playground/{{username}}/**/*
- name: personal documentation
path: docs/personal/{{username}}/**/*
path: docs/personal/{{username}}/**/*
2 changes: 1 addition & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ updateDocsComment: >
# Terms that if found in the title of a PR will prevent the bot from commenting on it
updateDocsWhiteList:
- bug
- chore
- chore
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!--
Thanks for contributing to the flutter-version fastlane plugin
-->
-->
6 changes: 3 additions & 3 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ categories:
- "docs"
- "documentation"
exclude-labels:
- 'skip-changelog'
- "skip-changelog"
version-resolver:
major:
labels:
Expand All @@ -41,9 +41,9 @@ version-resolver:
template: |
## What’s Changed 🔥
$CHANGES
## Contributors 👏
$CONTRIBUTORS
## Previous versions 🗄️
$PREVIOUS_TAG
6 changes: 3 additions & 3 deletions .github/tests_checker.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
comment: 'Maybe add tests to make sure this change works as expected?',
fileExtensions: ['.rb']
testDir: 'spec'
comment: "Maybe add tests to make sure this change works as expected?"
fileExtensions: [".rb"]
testDir: "spec"
6 changes: 6 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
coverage
test-results
node_modules
Gemfile.lock
CHANGELOG.md
docs/change.md
30 changes: 15 additions & 15 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
AllCops:
TargetRubyVersion: 2.6
Include:
- "lib/fastlane/plugin/flutter_version/actions/flutter_version_action.rb"
- "lib/fastlane/plugin/flutter_version/helper/flutter_version_helper.rb"
- "lib/fastlane/plugin/flutter_version/version.rb"
- "lib/fastlane/plugin/flutter_version.rb"
- "spec/flutter_version_action_spec.rb"
- "fastlane/Fastfile"
- "spec/spec_helper.rb"
- "fastlane-plugin-flutter_version.gemspec"
- "*/lib/assets/*Template"
- "*/lib/assets/*TemplateAndroid"
- "lib/fastlane/plugin/flutter_version/actions/flutter_version_action.rb"
- "lib/fastlane/plugin/flutter_version/helper/flutter_version_helper.rb"
- "lib/fastlane/plugin/flutter_version/version.rb"
- "lib/fastlane/plugin/flutter_version.rb"
- "spec/flutter_version_action_spec.rb"
- "fastlane/Fastfile"
- "spec/spec_helper.rb"
- "fastlane-plugin-flutter_version.gemspec"
- "*/lib/assets/*Template"
- "*/lib/assets/*TemplateAndroid"
Exclude:
- "**/lib/assets/custom_action_template.rb"
- "./vendor/**/*"
- "**/lib/assets/DefaultFastfileTemplate"
- "**/lib/assets/MatchfileTemplate"
- "**/spec/fixtures/broken_files/broken_file.rb"
- "**/lib/assets/custom_action_template.rb"
- "./vendor/**/*"
- "**/lib/assets/DefaultFastfileTemplate"
- "**/lib/assets/MatchfileTemplate"
- "**/spec/fixtures/broken_files/broken_file.rb"
Layout/SpaceAroundMethodCallOperator:
Enabled: false
Lint/RaiseException:
Expand Down
13 changes: 8 additions & 5 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"git.autofetch": true,
"git.autofetchPeriod": 60,
"git.fetchOnPull": true,
"git.pruneOnFetch": true
}
"git.autofetch": true,
"git.autofetchPeriod": 60,
"git.fetchOnPull": true,
"git.pruneOnFetch": true,
"editor.formatOnPaste": true,
"editor.formatOnSave": true,
"editor.tabSize": 2
}
26 changes: 13 additions & 13 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ To automatically fix many of the styling issues, use

```bash
bundle exec rake rubocop:auto_correct -a
```
```
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# flutter_version (Fastlane plugin)

<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->

[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter_version)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/tianhaoz95/fastlane-plugin-flutter_version)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/tianhaoz95/fastlane-plugin-flutter_version)
[![codecov](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version/branch/master/graph/badge.svg)](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version)

flutter_version is a Fastlane plugin to retrieve version code from Flutter projects which can be used to release changlogs and other metadata to marketplaces.
Expand Down Expand Up @@ -103,10 +106,10 @@ end

### Available options

| Name | Description | Optional | Type | Default |
|:---:|:---:|:---:|:---:|:---:|
| `pubspec_location` | The location of the `pubspec.yaml` file (relative to `Fastfile`). For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=flutter-config-file-location). | :white_check_mark: | `String` | `../pubspec.yaml` |
| `should_omit_version_code` | If the version code should be omitted for projects that do not use a version code. For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=version-code-omission). | :white_check_mark: | `Boolean` | `false` |
| Name | Description | Optional | Type | Default |
| :------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------: | :-------: | :---------------: |
| `pubspec_location` | The location of the `pubspec.yaml` file (relative to `Fastfile`). For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=flutter-config-file-location). | :white_check_mark: | `String` | `../pubspec.yaml` |
| `should_omit_version_code` | If the version code should be omitted for projects that do not use a version code. For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=version-code-omission). | :white_check_mark: | `Boolean` | `false` |

## About Fastlane

Expand Down
6 changes: 2 additions & 4 deletions config/copy-readme.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
{
"README.md": [
"docs/README.md"
]
}
"README.md": ["docs/README.md"]
}
13 changes: 8 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# flutter_version (Fastlane plugin)

<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->

[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter_version)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/tianhaoz95/fastlane-plugin-flutter_version)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/tianhaoz95/fastlane-plugin-flutter_version)
[![codecov](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version/branch/master/graph/badge.svg)](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version)

flutter_version is a Fastlane plugin to retrieve version code from Flutter projects which can be used to release changlogs and other metadata to marketplaces.
Expand Down Expand Up @@ -103,10 +106,10 @@ end

### Available options

| Name | Description | Optional | Type | Default |
|:---:|:---:|:---:|:---:|:---:|
| `pubspec_location` | The location of the `pubspec.yaml` file (relative to `Fastfile`). For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=flutter-config-file-location). | :white_check_mark: | `String` | `../pubspec.yaml` |
| `should_omit_version_code` | If the version code should be omitted for projects that do not use a version code. For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=version-code-omission). | :white_check_mark: | `Boolean` | `false` |
| Name | Description | Optional | Type | Default |
| :------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------: | :-------: | :---------------: |
| `pubspec_location` | The location of the `pubspec.yaml` file (relative to `Fastfile`). For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=flutter-config-file-location). | :white_check_mark: | `String` | `../pubspec.yaml` |
| `should_omit_version_code` | If the version code should be omitted for projects that do not use a version code. For details, see [here](https://tianhaoz.com/fastlane-plugin-flutter_version/#/options?id=version-code-omission). | :white_check_mark: | `Boolean` | `false` |

## About Fastlane

Expand Down
12 changes: 6 additions & 6 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
* [Getting Started](/README)
* [Available Option Details](/options)
* [For Developers](/development)
* [Security](/security)
* [Code of Conduct](/code)
* [Changelog](/change)
- [Getting Started](/README)
- [Available Option Details](/options)
- [For Developers](/development)
- [Security](/security)
- [Code of Conduct](/code)
- [Changelog](/change)
Loading

0 comments on commit b3f8fdc

Please sign in to comment.