Skip to content

Commit

Permalink
Merge pull request #3 from gastonpereyra/NPM-AOE-01-Update-Basic-Conf…
Browse files Browse the repository at this point in the history
…iguration

[PR] AOE- 01 - Update-Basic-Configuration
  • Loading branch information
gastonpereyra committed Aug 29, 2020
2 parents 61b8f01 + fcad6cd commit 5bea35e
Show file tree
Hide file tree
Showing 18 changed files with 3,567 additions and 28 deletions.
10 changes: 5 additions & 5 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ module.exports = {
'prefer-template': 0,
'import/no-unresolved': 0,
'import/no-extraneous-dependencies': ['error', { devDependencies: ['**/tests/**/*.js'] }],

'no-console': 0,
'no-bitwise': 0,

curly: ['error', 'multi-or-nest'],
Expand All @@ -51,10 +51,10 @@ module.exports = {
'func-names': 0,

'space-before-function-paren': ['error', {
'anonymous': 'never',
'named': 'never',
'asyncArrow': 'always'
}],
anonymous: 'never',
named: 'never',
asyncArrow: 'always'
}],

'arrow-parens': ['error', 'as-needed'],
'arrow-body-style': 0,
Expand Down
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug
about: To Report Bugs
title: "[BUG]"
labels: bug
assignees: gastonpereyra

---

# :bug: Bug
## :blue_book: Description
Trying to ... happens ...

## :confused: Expected behavior
I expected to have ...

## :arrows_clockwise: Steps
When fails I do
1. Start something
2. Later ...

## :on: Context
I used ... SO, and run it on ... Browse/Docker/Lambda.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Story
about: Story to organize development
title: "[STORY]"
labels: enhancement
assignees: gastonpereyra

---

# :bulb: Task
## :busts_in_silhouette: Role


## :point_up: Want
A

## :+1: Result
To

## :ok_hand: Criteria
-

## :blue_book: Description
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# :speech_balloon: Pull Request

## :link: Story
Closes #NUMBER

Link [TITLE](https://github.com/gastonpereyra/REPO_NAME/issues/NUMBER)

## :sparkles: Solution

## :checkered_flag: How to Test it
23 changes: 23 additions & 0 deletions .github/workflows/build-status.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Build Status

on:
push:
branches: [ '*' ]

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [12.x, 14.x]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm test
27 changes: 27 additions & 0 deletions .github/workflows/coverage-status.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Coverage Status

on: ["push", "pull_request"]

jobs:

build:
name: Build
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@v1

- name: Use Node.js 12.x
uses: actions/setup-node@v1
with:
node-version: 12.x

- name: npm install, make test-coverage
run: |
npm install
npm run test-ci
- name: Coveralls
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
15 changes: 15 additions & 0 deletions .github/workflows/linter-status.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Linter Status

on: ["push", "pull_request"]

jobs:
eslint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: hallee/eslint-action@1.0.3
# GITHUB_TOKEN in forked repositories is read-only
# https://help.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-event-pull_request
if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
with:
repo-token: ${{secrets.GITHUB_TOKEN}}
30 changes: 30 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: NPM Publish

on:
release:
types: [created]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12
- run: npm ci
- run: npm test

publish-npm:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: 12
registry-url: https://registry.npmjs.org/
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
67 changes: 66 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,62 @@ logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.token

# 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/
jspm_packages/

# TypeScript v1 declaration files
typings/

# 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/

# Optional REPL history
.node_repl_history

Expand All @@ -35,6 +71,35 @@ jspm_packages/

# dotenv environment variables file
.env
.env.test

# next.js build output
# parcel-bundler cache (https://parceljs.org/)
.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
3 changes: 2 additions & 1 deletion .nycrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"exclude": [
"tests/",
"coverage/",
".eslintrc.js"
".eslintrc.js",
"actions/"
],
"extension": [
".js"
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2020-07-11
## [Unreleased]
### Added
- Github Actions
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Ricardo Gastón Pereyra

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
# compareObject
# are-objects-equals

[![Build Status](https://travis-ci.org/compareObject.svg?branch=master)](https://travis-ci.org/compareObject)
[![Coverage Status](https://coveralls.io/repos/github/compareObject/badge.svg?branch=master)](https://coveralls.io/github/compareObject?branch=master)
## Code Quality Status
![Build Status](https://github.com/gastonpereyra/are-objects-equals/workflows/Build%20Status/badge.svg)
[![Coverage Status](https://img.shields.io/coveralls/github/gastonpereyra/are-objects-equals/master.svg)](https://coveralls.io/r/gastonpereyra/are-objects-equals?branch=master)

## Description
A tool to compare objects easyly

## Installation

```sh
npm install --save compareObject
```
npm i are-objects-equals
```

## Methods

## Usage

```js
const areObjectsEquals = require('are-objects-equals');

/*
output:
*/
```
## Extra
3 changes: 3 additions & 0 deletions lib/are-objects-equals.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'use strict'

module.exports = class areObjectsEquals {}
7 changes: 7 additions & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'use strict';

const AreObjectsEquals = require('./are-objects-equals');

module.exports = {
AreObjectsEquals
};
Loading

0 comments on commit 5bea35e

Please sign in to comment.