Merge pull request #1 from Runninghill/feature/implement

Setup project and created validator to validate RSA phone numbers

Author: Solenoden

.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.gitignore

@@ -1,104 +1,49 @@
-# 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
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+# Only exists if Bazel was run
+/bazel-out
+
+# dependencies
+/node_modules
+
+# profiling files
+chrome-profiler-events*.json
+speed-measure-plugin*.json
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
 
 # 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
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# 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
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db

CONTRIBUTOR_README.md

@@ -0,0 +1,47 @@
+# Angular South African Form Validators
+
+A set of South African specific validators for Angular forms.
+
+# Getting Started
+
+1. Clone the repo.
+
+3. Navigate to `projects/rh-rsa-form-validators`
+
+2. Run `npm install`.
+
+4. Create a feature or bugfix branch.
+
+3. Make your changes.
+
+4. Ensure that your changes are of good quality and comply with our [Coding Standards](#coding-standards).
+
+5. Commit your changes and submit a PR to merge your changes into `main`.
+
+# NPM Scripts
+
+To check eslint, run command `npm run lint`.
+
+To check unit tests, run command `npm run test`.
+
+# Contribute
+
+Ensure you work out of the project itself (`projects/rh-rsa-form-validators`) and not the Angular workspace
+
+Always make the code better, if you see errors, please fix them. 
+
+Add tests and try to move the code coverage up to 90%. 
+
+Update the [usage documentation](/projects/rh-rsa-form-validators/README.md).
+
+Bump the version number according to [semantic versioning](https://semver.org/#semantic-versioning-200).
+
+Adhere to the [Coding Standards](#coding-standards).
+
+Only the classes and models exported in `public-api.ts` will be exposed through the package.
+
+# Coding Standards
+
+TODO: Define coding standards
+
+- Form validators should not make the form control required.

README.md

@@ -0,0 +1,50 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "rh-rsa-form-validators": {
+      "projectType": "library",
+      "root": "projects/rh-rsa-form-validators",
+      "sourceRoot": "projects/rh-rsa-form-validators/src",
+      "prefix": "lib",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "tsConfig": "projects/rh-rsa-form-validators/tsconfig.lib.json",
+            "project": "projects/rh-rsa-form-validators/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/rh-rsa-form-validators/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/rh-rsa-form-validators/src/test.ts",
+            "tsConfig": "projects/rh-rsa-form-validators/tsconfig.spec.json",
+            "karmaConfig": "projects/rh-rsa-form-validators/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/rh-rsa-form-validators/tsconfig.lib.json",
+              "projects/rh-rsa-form-validators/tsconfig.spec.json"
+            ],
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        }
+      }
+    }},
+  "cli": {
+    "analytics": false
+  },
+  "defaultProject": "rh-rsa-form-validators"
+}