Skip to content

Commit

Permalink
Merge branch 'feature/password-generator'
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienrousseau committed Apr 19, 2022
2 parents 5059ad9 + d6bf3a4 commit 6c164f8
Show file tree
Hide file tree
Showing 68 changed files with 745 additions and 2,748 deletions.
8 changes: 8 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
!.*

/build/**
/coverage/**
/dist/**
/test/**
/node_modules/**
!.eslintrc.json
17 changes: 7 additions & 10 deletions . eslintrc → .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
{
"env": {
"browser": true,
"commonjs": true,
"es8": true,
"es6": true,
"node": true
},
"extends": ["plugin:import/recommended"],
"parser": "@babel/eslint-parser",
"parserOptions": {
"ecmaVersion": 2020,
"ecmaVersion": 2018,
"sourceType": "module"
},
"extends": [
"plugin:node/recommended"
],
"plugins": ["import"],
"rules": {
"camelcase": [1, {"properties": "always"}],
"comma-dangle": 0,
Expand All @@ -24,7 +22,6 @@
"key-spacing": [2, {"beforeColon": false, "afterColon": true}],
"keyword-spacing": 2,
"linebreak-style": 0,
"node/file-extension-in-import": ["error", "never"],
"no-console": 0,
"no-irregular-whitespace": 2,
"no-multi-str": 2,
Expand All @@ -35,10 +32,10 @@
"no-unused-vars": 2,
"no-use-before-define": [2, "nofunc"],
"operator-linebreak": [2, "after"],
"quotes": [2, "single"],
"quotes": [2, "double"],
"semi": [2, "always"],
"space-before-blocks": [2, "always"],
"space-before-function-paren": [2, "always"],
"space-before-function-paren": [2, "never"],
"space-infix-ops": 2,
"strict": [2, "global"],
"wrap-iife": [2, "inside"]
Expand Down
10 changes: 10 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#
# Main entry file needs lf only line endings so that bash shell doesn't barf.
#
src/bin/index.js text eol=lf
#
# Avoid crlf translation noise on npm written files
#
package.json text eol=lf
package-lock.json text eol=lf

5 changes: 0 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Contributing

Thank you so much for wanting to contribute to the Password Generator! There are a couple ways to help out.

## Evangelize

Just tell people about the Password Generator. We believe that a bigger, more involved community makes for a better framework, and that better frameworks make the world a better place. We can always use more feedback.

## How to Contribute

Here are guides for submitting issues and pull requests.
Expand All @@ -25,23 +23,20 @@ Warning us of a bug is possibly the single most valuable contribution you can ma
### Code Contributions

Contributing code is one of the more difficult ways to contribute to the Password Generator.

#### Feature Requests

Filing feature requests is one of the most popular ways to contribute to the Password Generator.

Is there some feature request that you'd like to code up yourself? Is there a feature you asked for yourself that you'd like to code?

Here's how to contribute code for a new feature to the Password Generator. Pull Requests allow you to share your own code with us, and we can merge it into the main repo.

#### Adding Code

- Fork the repo.
- Clone the Password Generator repo by running: `git clone https://github.com/sebastienrousseau/password-generator.git`
- Install Node.js if you haven't already, and run `npm install`. This installs the required dependencies for building the Password Generator.
- Edit files in the `src/` folder. Don't edit any files in the `dist/` folder, this is only for distribution builds, which are automated.
- Run `npm run build` to trigger builds, and the new distribution files will be in the `dist/` folder ready to go.

#### Fixing an Issue

Have you found a solution to an issue? Here is how you can submit your code to the Password Generator.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
# Bug report
Create a report to help us improve

## Describe the bug

Expand All @@ -14,10 +9,10 @@ A clear and concise description of what the bug is.

Steps to reproduce the behavior:

- Go to '...'
- Click on '....'
- Scroll down to '....'
- See error
- Go to '...'
- Click on '....'
- Scroll down to '....'
- See error

## Expected behavior

Expand All @@ -28,15 +23,15 @@ 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
- Browser
- Version

**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
- OS
- Browser
- Version

**Additional context**
Add any other context about the problem here.
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
# Feature request

---
Suggest an idea for this project

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

A clear and concise description of what the problem is.

**Describe the solution you'd like**

A clear and concise description of what you want to happen.

**Describe alternatives you've considered**

A clear and concise description of any alternative solutions or features you've considered.

**Additional context**

Add any other context or screenshots about the feature request here.
1 change: 0 additions & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
We take the security of our software products and services seriously, which includes all source code repositories managed through our GitHub repositories.

If you believe you have found a security vulnerability in any of our repository, please report it to us as described below.

## Reporting Security Issues

Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
Expand Down
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
#
# ___ _ ___ _
# | _ \__ _ _______ __ _____ _ _ __| | / __|___ _ _ ___ _ _ __ _| |_ ___ _ _
# | _/ _` (_-<_-< V V / _ \ '_/ _` | | (_ / -_) ' \/ -_) '_/ _` | _/ _ \ '_|
# |_| \__,_/__/__/\_/\_/\___/_| \__,_| \___\___|_||_\___|_| \__,_|\__\___/_|
#
# Password Generator
# https://password-generator.pro/
#
# Copyright (c) Sebastien Rousseau 2022. All rights reserved
# Licensed under the MIT license
#

version: 2
updates:
- package-ecosystem: "npm"
Expand Down
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ coverage
# Bower dependency directory (https://bower.io/)
bower_components

# Mocha-specific
mocha.js
mocha.js.map
.karma/
!bin/mocha.js
!lib/mocha.js

# Bundle debugging
stats.html

# node-waf configuration
.lock-wscript

Expand Down
2 changes: 0 additions & 2 deletions .npmignore

This file was deleted.

18 changes: 18 additions & 0 deletions .remarkrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"plugins": [
"remark-preset-lint-recommended",
"remark-preset-lint-markdown-style-guide",
"remark-preset-lint-consistent",
["remark-lint-list-item-spacing", false],
["remark-lint-maximum-heading-length", false],
["remark-lint-list-item-indent", false],
["remark-lint-maximum-line-length", false],
[
"remark-lint-fenced-code-flag",
{
"allowEmpty": true
}
],
"validate-links"
]
}
32 changes: 32 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
install: install-deps

run:
npx babel-node 'src/bin/password-generator.js' production

dev:
npx nodemon --delay 1 --exec babel-node 'src/bin/password-generator.js' developer

install-deps:
npm ci

build:
rm -rf dist
npm run build

test:
npm test

test-coverage:
nyc npm run test

lint:
npx eslint .

package:
npm pack

publish:
npm publish

update-deps:
npx npm-check-updates -u
Loading

0 comments on commit 6c164f8

Please sign in to comment.