Skip to content

Commit

Permalink
Macro testing
Browse files Browse the repository at this point in the history
Co-authored-by: Brandon Williams <[email protected]>
  • Loading branch information
stephencelis and mbrandonw committed Sep 17, 2023
0 parents commit e2659dd
Show file tree
Hide file tree
Showing 51 changed files with 3,808 additions and 0 deletions.
132 changes: 132 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

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

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
<[email protected]>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: Something isn't working as expected
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thank you for contributing to swift-macro-testing!
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
- type: textarea
attributes:
label: Description
description: |
A short description of the incorrect behavior.
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
validations:
required: true
- type: checkboxes
attributes:
label: Checklist
options:
- label: If possible, I've reproduced the issue using the `main` branch of this package.
required: false
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/pointfreeco/swift-macro-testing/issues) or [discussion](https://github.com/pointfreeco/swift-macro-testing/discussions).
required: true
- type: textarea
attributes:
label: Expected behavior
description: Describe what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Actual behavior
description: Describe or copy/paste the behavior you observe.
validations:
required: false
- type: textarea
attributes:
label: Steps to reproduce
description: |
Explanation of how to reproduce the incorrect behavior.
This could include an attached project or link to code that is exhibiting the issue, and/or a screen recording.
placeholder: |
1. ...
validations:
required: false
- type: input
attributes:
label: swift-macro-testing version information
description: The version of swift-macro-testing used to reproduce this issue.
placeholder: "'0.1.0' for example, or a commit hash"
- type: input
attributes:
label: Destination operating system
description: The OS running swift-macro-testing.
placeholder: "'macOS 14' for example"
- type: input
attributes:
label: Xcode version information
description: The version of Xcode used to reproduce this issue.
placeholder: "The version displayed from 'Xcode 〉About Xcode'"
- type: textarea
attributes:
label: Swift Compiler version information
description: The version of Swift used to reproduce this issue.
placeholder: Output from 'xcrun swiftc --version'
render: shell
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
blank_issues_enabled: false

contact_links:
- name: Project Discussion
url: https://github.com/pointfreeco/swift-macro-testing/discussions
about: Library Q&A, ideas, and more
- name: Documentation
url: https://swiftpackageindex.com/pointfreeco/swift-macro-testing/main/documentation
about: Read the documentation
- name: Videos
url: https://www.pointfree.co/episodes/ep250-testing-debugging-macros-part-1
about: Watch videos to get a behind-the-scenes look at how this library was motivated and built
- name: Slack
url: https://www.pointfree.co/slack-invite
about: Community chat
65 changes: 65 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: CI

on:
push:
branches:
- main
pull_request:
branches:
- '*'
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
macos:
name: macOS
runs-on: macos-13
steps:
- uses: actions/checkout@v4
- name: Select Xcode 15
run: sudo xcode-select -s /Applications/Xcode_15.0.app
- name: Run tests
run: swift test

linux:
name: Linux
runs-on: ubuntu-latest
steps:
- name: Install Swift
uses: slashmo/[email protected]
with:
version: swift-5.9-DEVELOPMENT-SNAPSHOT-2023-09-16-a
- uses: actions/checkout@v4
- name: Run tests
run: swift test

# NB: 5.9 snapshot unavailable, wait for release
# wasm:
# name: Wasm
# runs-on: ubuntu-latest
# strategy:
# matrix:
# include:
# - { toolchain: wasm-5.9-RELEASE }
# steps:
# - uses: actions/checkout@v4
# - run: echo "${{ matrix.toolchain }}" > .swift-version
# - uses: swiftwasm/[email protected]
# with:
# shell-action: carton test --environment node

# NB: 5.9 snapshot outdated, wait for release
# windows:
# name: Windows
# runs-on: windows-latest
# steps:
# - uses: compnerd/gha-setup-swift@main
# with:
# branch: swift-5.9-release
# tag: 5.9-DEVELOPMENT-SNAPSHOT-2023-09-16-a
# - uses: actions/checkout@v4
# - name: Run tests
# run: swift test
29 changes: 29 additions & 0 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Format

on:
push:
branches:
- main

concurrency:
group: format-${{ github.ref }}
cancel-in-progress: true

jobs:
swift_format:
name: swift-format
runs-on: macos-13
steps:
- uses: actions/checkout@v3
- name: Xcode Select
run: sudo xcode-select -s /Applications/Xcode_14.3.1.app
- name: Tap
run: brew install swift-format
- name: Format
run: make format
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Run swift-format
branch: 'main'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.DS_Store
/.build
/Packages
xcuserdata/
DerivedData/
.swiftpm/configuration/registries.json
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
.netrc
11 changes: 11 additions & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# This is manifest file for the Swift Package Index for it to auto-generate and
# host DocC documentation.
#
# For reference see https://swiftpackageindex.com/swiftpackageindex/spimanifest/documentation/spimanifest/commonusecases#Host-DocC-documentation-in-the-Swift-Package-Index

version: 1
builder:
configs:
- documentation_targets:
# First item in the list is the "landing" (default) target
- MacroTesting
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>IDEDidComputeMac32BitWarning</key>
<true/>
</dict>
</plist>
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
format:
swift format \
--ignore-unparsable-files \
--in-place \
--recursive \
./Package.swift ./Sources ./Tests

.PHONY: format
23 changes: 23 additions & 0 deletions Package.resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"pins" : [
{
"identity" : "swift-snapshot-testing",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-snapshot-testing",
"state" : {
"revision" : "696b86a6d151578bca7c1a2a3ed419a5f834d40f",
"version" : "1.13.0"
}
},
{
"identity" : "swift-syntax",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-syntax.git",
"state" : {
"revision" : "74203046135342e4a4a627476dd6caf8b28fe11b",
"version" : "509.0.0"
}
}
],
"version" : 2
}
Loading

0 comments on commit e2659dd

Please sign in to comment.