Skip to content

Commit

Permalink
chore(*): Maintanance (#199)
Browse files Browse the repository at this point in the history
- Update dependencies (not Angular!)
- Migrate and cleanup config files
- Cleanup README and CHANGELOG
- Fix update-package script
- Introduce ESLint & Prettier
- Migrate from Travis CI to GitHub actions
  • Loading branch information
dominique-mueller authored Mar 10, 2021
1 parent fd1311a commit 19e7e95
Show file tree
Hide file tree
Showing 64 changed files with 20,200 additions and 21,833 deletions.
7 changes: 4 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Editor configuration, see https://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = tab
indent_size = 4
end_of_line = crlf
indent_size = 2
indent_style = space
insert_final_newline = true
max_line_length = 140
trim_trailing_whitespace = true

[*.md]
Expand Down
23 changes: 23 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"parser": "@typescript-eslint/parser",
"parserOptions": {
"tsconfigRootDir": ".",
"project": ["./tsconfig.json"]
},
"plugins": ["@typescript-eslint", "prettier", "simple-import-sort"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"prettier",
"prettier/@typescript-eslint",
"plugin:prettier/recommended"
],
"rules": {
"@typescript-eslint/no-explicit-any": "off",
"import/order": "off",
"simple-import-sort/exports": "error",
"simple-import-sort/imports": "error",
"sort-imports": "off"
}
}
59 changes: 59 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: CI

on:
push:
branches: [develop]
pull_request:
branches: [develop]

jobs:
build:
name: Build
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Setup NodeJS
uses: actions/setup-node@v2
with:
node-version: 14.15.x
- name: Install dependencies
run: npm ci
- name: Build library
run: npm run build:library
- name: Build demo
run: npm run build:demo

lint:
name: Lint
needs: build
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Setup NodeJS
uses: actions/setup-node@v2
with:
node-version: 14.15.x
- name: Install dependencies
run: npm ci
- name: Lint library
run: npm run lint:library

test:
name: Test
needs: build
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Setup NodeJS
uses: actions/setup-node@v2
with:
node-version: 14.15.x
- name: Install dependencies
run: npm ci
- name: Test library
run: npm run test:library
- name: Upload test coverage
run: npm run test:library:upload-coverage
26 changes: 26 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Release

on:
release:
types: [published]

jobs:
publish-to-npm:
name: Publish to npm
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Setup NodeJS
uses: actions/setup-node@v2
with:
node-version: 14.15.x
registry-url: 'https://registry.npmjs.org'
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build:library
- name: Publish to npm
run: npm publish ./dist/angular-notifier
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
147 changes: 112 additions & 35 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,46 +1,123 @@
# Created by https://www.gitignore.io/api/angular,visualstudiocode
# Edit at https://www.gitignore.io/?templates=angular,visualstudiocode

### Angular ###
## Angular ##
# compiled output
dist/
tmp/
app/**/*.js
app/**/*.js.map

# dependencies
# Created by https://www.toptal.com/developers/gitignore/api/node,vscode
# Edit at https://www.toptal.com/developers/gitignore?templates=node,vscode

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
bower_components/

# IDEs and editors
.idea/

# misc
.sass-cache/
connect.lock/
coverage/
libpeerconnection.log/
npm-debug.log
testem.log
jspm_packages/

# TypeScript v1 declaration files
typings/

# e2e
e2e/*.js
e2e/*.map
# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

#System Files
.DS_Store/
# Optional REPL history
.node_repl_history

### VisualStudioCode ###
# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test
.env*.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

### vscode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

### VisualStudioCode Patch ###
# Ignore all local history of files
.history

# End of https://www.gitignore.io/api/angular,visualstudiocode
# End of https://www.toptal.com/developers/gitignore/api/node,vscode
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"arrowParens": "always",
"endOfLine": "auto",
"printWidth": 140,
"singleQuote": true,
"trailingComma": "all"
}
27 changes: 2 additions & 25 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

Also see the **[release page](https://github.com/dominique-mueller/angular-notifier.git/releases)**.
Also see **[GitHub releases](https://github.com/dominique-mueller/angular-notifier/releases)**.

<br>

Expand Down Expand Up @@ -163,10 +163,6 @@ Also see the **[release page](https://github.com/dominique-mueller/angular-notif

* **config:** Fixed broken configuration merge ([9793773](https://github.com/dominique-mueller/angular-notifier/commit/9793773))

### Tests

* **library:** Added unit tests for the whole source code ([3624eef](https://github.com/dominique-mueller/angular-notifier/commit/3624eef))

<br>

## [1.0.1](https://github.com/dominique-mueller/angular-notifier/releases/tag/1.0.1) (2016-12-05)
Expand All @@ -180,23 +176,4 @@ Also see the **[release page](https://github.com/dominique-mueller/angular-notif

## [1.0.0](https://github.com/dominique-mueller/angular-notifier/releases/tag/1.0.0) (2016-12-04)

### Features

* **config:** Added new options, docs improbement, refactoring ([745e47e](https://github.com/dominique-mueller/angular-notifier/commit/745e47e))
* **library:** Added animations ([bdec4ab](https://github.com/dominique-mueller/angular-notifier/commit/bdec4ab))
* **library:** Added minimal feature implementation ([36aa4e3](https://github.com/dominique-mueller/angular-notifier/commit/36aa4e3))
* **library:** Extended API ([4fcab3b](https://github.com/dominique-mueller/angular-notifier/commit/4fcab3b))

### Bug Fixes

* **gulp:** Fixed build process to make it work on Travis CI again ([0e21209](https://github.com/dominique-mueller/angular-notifier/commit/0e21209))

### Documentation

* **readme:** Added docs with image, updated demo ([1ee2ca2](https://github.com/dominique-mueller/angular-notifier/commit/1ee2ca2))

<br>

---

<sup>*Changelog generated automatically by [automatic-release](https://github.com/dominique-mueller/automatic-release).*</sup>
Initial release!
17 changes: 0 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@

**A well designed, fully animated, highly customizable, and easy-to-use notification library for your **Angular 2+** application.**

[![npm version](https://img.shields.io/npm/v/angular-notifier.svg?maxAge=3600&style=flat)](https://www.npmjs.com/package/angular-notifier)
[![dependency status](https://img.shields.io/david/dominique-mueller/angular-notifier.svg?maxAge=3600&style=flat)](https://david-dm.org/dominique-mueller/angular-notifier)
[![travis ci build status](https://img.shields.io/travis/dominique-mueller/angular-notifier/master.svg?maxAge=3600&style=flat)](https://travis-ci.org/dominique-mueller/angular-notifier)
[![Codecov](https://img.shields.io/codecov/c/github/dominique-mueller/angular-notifier.svg?maxAge=3600&style=flat)](https://codecov.io/gh/dominique-mueller/angular-notifier)
[![Known Vulnerabilities](https://snyk.io/test/github/dominique-mueller/angular-notifier/badge.svg)](https://snyk.io/test/github/dominique-mueller/simple-progress-webpack-plugin)
[![license](https://img.shields.io/npm/l/angular-notifier.svg?maxAge=3600&style=flat)](https://github.com/dominique-mueller/angular-notifier/LICENSE)

</div>

<br><br>
Expand Down Expand Up @@ -536,13 +529,3 @@ const notifierDefaultOptions: NotifierOptions = {
}
};
```

<br><br><br>

## Creator

**Dominique Müller**

- E-Mail: **[[email protected]](mailto:[email protected])**
- Website: **[www.devdom.io](https://www.devdom.io)**
- Twitter: **[@itsdevdom](https://twitter.com/itsdevdom)**
File renamed without changes.
Loading

0 comments on commit 19e7e95

Please sign in to comment.