Skip to content

Commit

Permalink
chore: more formatting updates + remove legacy semaphore config
Browse files Browse the repository at this point in the history
  • Loading branch information
RobBrazier committed Mar 5, 2023
1 parent f5f14b7 commit 9083ab7
Show file tree
Hide file tree
Showing 22 changed files with 128 additions and 229 deletions.
8 changes: 4 additions & 4 deletions .github/dependabot.yml
@@ -1,6 +1,6 @@
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: monthly
- package-ecosystem: npm
directory: '/'
schedule:
interval: monthly
32 changes: 16 additions & 16 deletions .github/mergify.yml
@@ -1,47 +1,47 @@
pull_request_rules:
- name: Dependabot automatic merge
conditions:
- "author=dependabot[bot]"
- "check-success=linting"
- "check-success=build_components"
- "#check-success>=3"
- "#check-failure=0"
- 'author=dependabot[bot]'
- 'check-success=linting'
- 'check-success=build_components'
- '#check-success>=3'
- '#check-failure=0'
- '-body~=[bB]reaking'
actions:
merge:
method: rebase
- name: Request review for breaking changes
conditions:
- "author=dependabot[bot]"
- 'author=dependabot[bot]'
- 'body~=[bB]reaking'
actions:
request_reviews:
users:
- RobBrazier
- name: Dependabot request reviews
conditions:
- "author=dependabot[bot]"
- "#check-failure>=1"
- 'author=dependabot[bot]'
- '#check-failure>=1'
actions:
request_reviews:
users:
- RobBrazier
- name: Add reviewer to PRs
conditions:
- "-author=dependabot[bot]"
- '-author=dependabot[bot]'
actions:
request_reviews:
users:
- RobBrazier
- name: Merge PR on approval
conditions:
- "author=dependabot[bot]"
- "base=master"
- "check-success=linting"
- "check-success=build_components"
- "#check-success>=3"
- "#check-failure=0"
- "approved-reviews-by=RobBrazier"
- 'author=dependabot[bot]'
- 'base=master'
- 'check-success=linting'
- 'check-success=build_components'
- '#check-success>=3'
- '#check-failure=0'
- 'approved-reviews-by=RobBrazier'
actions:
merge:
method: merge
File renamed without changes.
22 changes: 11 additions & 11 deletions .github/workflows/build.yaml
Expand Up @@ -36,17 +36,17 @@ jobs:
- name: Run test suite
run: npm run lint

# - name: SonarCloud Scan
# uses: SonarSource/sonarcloud-github-action@v1.6
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
# with:
# args: >
# -Dsonar.organization=robbrazier
# -Dsonar.projectKey=RobBrazier_svelte-awesome
# -Dsonar.sources=src
# -Dsonar.tests=tests
# - name: SonarCloud Scan
# uses: SonarSource/sonarcloud-github-action@v1.6
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
# with:
# args: >
# -Dsonar.organization=robbrazier
# -Dsonar.projectKey=RobBrazier_svelte-awesome
# -Dsonar.sources=src
# -Dsonar.tests=tests

build_components:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yaml
Expand Up @@ -28,7 +28,7 @@ jobs:

- name: Build Example/Docs
env:
BASE_PATH: "/svelte-awesome"
BASE_PATH: '/svelte-awesome'
run: |
npm run build
touch build/.nojekyll
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tag.yaml
Expand Up @@ -3,7 +3,7 @@ name: Publish version to NPM
on:
push:
tags:
- "*.*.*"
- '*.*.*'

jobs:
build:
Expand Down
3 changes: 2 additions & 1 deletion .prettierignore
Expand Up @@ -12,4 +12,5 @@ pnpm-lock.yaml
package-lock.json
yarn.lock

src/lib/icons/*.json
src/lib/icons/*.json
src/lib/icons/index.ts
16 changes: 8 additions & 8 deletions .prettierrc
@@ -1,10 +1,10 @@
{
"useTabs": false,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"plugins": ["prettier-plugin-svelte"],
"pluginSearchDirs": ["."],
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }],
"svelteSortOrder": "markup-styles-scripts-options"
"useTabs": false,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"plugins": ["prettier-plugin-svelte"],
"pluginSearchDirs": ["."],
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }],
"svelteSortOrder": "markup-styles-scripts-options"
}
4 changes: 2 additions & 2 deletions .release-it.yml
@@ -1,13 +1,13 @@
git:
changelog: "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs"
changelog: 'npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs'
push: false
tag: true
commit: true
tagName: v${version}
github:
release: false
hooks:
after:bump: "npx auto-changelog -v ${version}"
after:bump: 'npx auto-changelog -v ${version}'
npm:
publish: false
skipChecks: true
11 changes: 0 additions & 11 deletions .semaphore/publish.sh

This file was deleted.

49 changes: 0 additions & 49 deletions .semaphore/publish.yml

This file was deleted.

55 changes: 0 additions & 55 deletions .semaphore/semaphore.yml

This file was deleted.

33 changes: 19 additions & 14 deletions README.md
@@ -1,4 +1,5 @@
# Svelte-Awesome

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/RobBrazier/svelte-awesome/build.yaml?style=flat-square&branch=master)](https://github.com/RobBrazier/svelte-awesome/actions)
[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/RobBrazier_svelte-awesome?server=https%3A%2F%2Fsonarcloud.io&style=flat-square)](https://sonarcloud.io/summary/overall?id=RobBrazier_svelte-awesome)
[![Sonar Coverage](https://img.shields.io/sonar/coverage/RobBrazier_svelte-awesome?server=https%3A%2F%2Fsonarcloud.io&style=flat-square)](https://sonarcloud.io/summary/overall?id=RobBrazier_svelte-awesome)
Expand All @@ -17,32 +18,34 @@ A demo is available [here][demo]
A list of all available embedded icons is available [here][icons]

## Installation

### NPM

```bash
npm install --save svelte-awesome
```

## Usage

```html
<!-- basic -->
<Icon data={beer}/>
<Icon data="{beer}" />
<!-- codeFork is camelCase, unlike the js file, code-fork.js -->
<Icon data={codeFork}/>

<Icon data="{codeFork}" />

<!-- with options -->
<Icon data={refresh} scale="2"/>
<Icon data={comment} flip="horizontal"/>
<Icon data={codeFork} label="Forked Repository"/>
<Icon data="{refresh}" scale="2" />
<Icon data="{comment}" flip="horizontal" />
<Icon data="{codeFork}" label="Forked Repository" />

<!-- stacked icons [WIP] -->
<Icon label="No Photos">
<Icon data={camera}/>
<Icon name={ban} scale="2" class="alert"/>
<Icon data="{camera}" />
<Icon name="{ban}" scale="2" class="alert" />
</Icon>

<!-- FontAwesome v5 and v6 Icons supported -->
<Icon data={faThumbsUp}/>
<Icon data="{faThumbsUp}" />

<script>
import Icon from 'svelte-awesome/components/Icon.svelte';
Expand All @@ -66,20 +69,22 @@ npm install --save svelte-awesome
import { faThumbsUp } from '@fortawesome/free-regular-svg-icons/faThumbsUp';
// Not Recommended - import the individual icon from the main file - it will download all of the icons in dev mode
import { faThumbsUp } from '@fortawesome/free-regular-svg-icons';
</script>
```

## Sapper Usage

For Sapper, you may need to import the Icon component explicitly as below:

```javascript
import Icon from 'svelte-awesome/components/Icon.svelte'
import Icon from 'svelte-awesome/components/Icon.svelte';
```

## Contributors
- [dimfeld](https://github.com/dimfeld)
- [lucasnad27](https://github.com/lucasnad27)
- [josdejong](https://github.com/josdejong)

- [dimfeld](https://github.com/dimfeld)
- [lucasnad27](https://github.com/lucasnad27)
- [josdejong](https://github.com/josdejong)

[vue-awesome]: https://github.com/Justineo/vue-awesome
[font-awesome]: https://github.com/FortAwesome/Font-Awesome
Expand Down

0 comments on commit 9083ab7

Please sign in to comment.