Create validator to validate South African phone numbers.

Signed-off-by: Gavin de Bruyn <gavindb@runninghill.co.za>

Author: Solenoden

.gitignore

@@ -31,6 +31,9 @@ speed-measure-plugin*.json
 !.vscode/extensions.json
 .history/*
 
+# Coverage directory used by tools like istanbul
+coverage
+
 # misc
 /.sass-cache
 /connect.lock

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,36 @@
+{
+  "env": {
+    "node": true,
+    "commonjs": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 12
+  },
+  "rules": {
+    "complexity": ["error"],
+    "default-case": ["error"],
+    "eqeqeq": ["error"],
+    "keyword-spacing": ["error"],
+    "max-len": ["error", 120],
+    "no-alert": ["error"],
+    "no-console": ["error"],
+    "no-else-return": ["error"],
+    "no-extra-parens": ["error"],
+    "no-multi-spaces": ["error"],
+    "no-multiple-empty-lines": ["error", { "max" : 1 }],
+    "no-unreachable-loop": ["error"],
+    "no-template-curly-in-string": ["error"],
+    "object-curly-spacing": ["error", "always"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "never"]
+  }
+}

projects/rh-rsa-form-validators/.eslintrc.json

@@ -1,24 +1,21 @@
-# RhRsaFormValidators
+# Angular South African Form Validators
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.2.4.
+A set of South African specific validators for Angular forms.
 
-## Code scaffolding
+TODO: Add the Runninghill and Angular logos as well as some emojis
 
-Run `ng generate component component-name --project rh-rsa-form-validators` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project rh-rsa-form-validators`.
-> Note: Don't forget to add `--project rh-rsa-form-validators` or else it will be added to the default project in your `angular.json` file. 
+# Getting Started
 
-## Build
+If you plan on contributing to the package please read the contributor readme.
 
-Run `ng build rh-rsa-form-validators` to build the project. The build artifacts will be stored in the `dist/` directory.
+1. Run `npm install rh-angular-rsa-form-validators` in your Angular project.
 
-## Publishing
+2. Import and use the exposed classes to validate your Angular form controls.
 
-After building your library with `ng build rh-rsa-form-validators`, go to the dist folder `cd dist/rh-rsa-form-validators` and run `npm publish`.
+# Usage
 
-## Running unit tests
+TODO: Fill out usage section
 
-Run `ng test rh-rsa-form-validators` to execute the unit tests via [Karma](https://karma-runner.github.io).
+# API Reference
 
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+TODO: Fill out api reference section

projects/rh-rsa-form-validators/README.md

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+}