Skip to content

Commit

Permalink
Merge pull request #14 from patw0929/feature-filter-metadata
Browse files Browse the repository at this point in the history
feat(filter-metadata): Filtered google lib metadata
  • Loading branch information
nutboltu committed Dec 4, 2019
2 parents 9dd174d + 2c4a62e commit cea625a
Show file tree
Hide file tree
Showing 11 changed files with 2,419 additions and 1,260 deletions.
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,15 @@ npm-debug.log
yarn-error.log

coverage


# Ignore cloned files
closure-compiler/
closure-library/
closure-linter/
libphonenumber/

#generated files
dist/
src/PhoneNumberMetadata.xml
src/PhoneNumberMetadataForTesting.xml
5 changes: 2 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
language: java
jdk: oraclejdk8
jdk: openjdk8
cache:
directories:
- closure-library
Expand All @@ -9,11 +9,10 @@ cache:
notifications:
email: false
before_install:
- nvm install node
- nvm install 11.10.1
install:
- npm ci
- bash ./scripts/build-dependencies.sh
- git clone --branch v`cat package.json | python -c "import sys, json; print(json.load(sys.stdin)['googleLibphonenumberVersion'])"` https://github.com/googlei18n/libphonenumber/
script:
- bash ./scripts/execute.sh
- npm test
Expand Down
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,52 @@
# Libphonenumber-js-utils · [![npm version](https://badge.fury.io/js/libphonenumber-js-utils.svg)](https://www.npmjs.com/package/libphonenumber-js-utils) [![Build Status](https://travis-ci.org/patw0929/libphonenumber-js-utils.svg)](https://travis-ci.org/patw0929/libphonenumber-js-utils)

# What is it?
## What is it

This repo is a compiled and minified version of the utilities functions from the [googlei18n's libphonenumber](https://github.com/googlei18n/libphonenumber) library.
The functions are exposed to `window.intlTelInputUtils` inside browser environment.

# How to use?
## How to use

* Add `libphonenumber-js-utils` to the package dependency.
* `import 'libphonenumber-js-utils';` in your code.
* The functions will be available in `window.intlTelInputUtils`.

# Features inside it :
## Features inside it

Name | Type | Description
-----|------|---------------
formatNumber | Function | Format Phone number according to country
getExampleNumber | Function | Get example phonenumber of a country
getExtension | Function |
getExtension | Function |
getNumberType | Function | Get the type of number entered like `FIXED_LINE`, `MOBILE`, etc.
getValidationError | Function | Get the validation error
isValidNumber | Function | Check if a number is valid for a country
numberFormat | Enum | **Possible Values:**<br>&bull; `NATIONAL` <br>&bull; `INTERNATIONAL`
numberType | Enum | **Possible Values:**<br>&bull; `FIXED_LINE` <br>&bull; `MOBILE` <br>&bull; `FIXED_LINE_OR_MOBILE` <br>&bull; `TOLL_FREE` <br>&bull; `PREMIUM_RATE` <br>&bull; `SHARED_COST` <br>&bull; `VOIP` <br>&bull; `PERSONAL_NUMBER` <br>&bull; `PAGER` <br>&bull; `UAN` <br>&bull; `VOICEMAIL` <br>&bull; `UNKNOWN`
numberType | Enum | **Possible Values:**<br>&bull; `FIXED_LINE` <br>&bull; `MOBILE` <br>&bull; `UNKNOWN`
validationError | Enum | **Possible Values:**<br>&bull; `IS_POSSIBLE` <br>&bull; `INVALID_COUNTRY_CODE` <br>&bull; `TOO_SHORT` <br>&bull; `TOO_LONG` <br>&bull; `NOT_A_NUMBER`

# How to build it?
### Setup :
Checkout closure-library, closure-compiler, closure-linter and python-gflags next to libphonenumber:

* `git clone https://github.com/googlei18n/libphonenumber/`
## How to build it

* `git clone https://github.com/google/closure-library/`
### Install Dependencies

* `git clone https://github.com/google/closure-compiler.git`
Install `maven` and `ant`. For MacOS

* `git clone https://github.com/google/closure-linter.git`
```sh
brew install ant
brew install maven
```

* `git clone https://github.com/google/python-gflags.git`
```sh
sh scripts/build-dependencies.sh
```

### Compile :
1. Build Closure's compiler.jar:
`mvn -DskipTests`
2. Copy the contents of
`src/libphonenumber.js` to `libphonenumber/javascript/i18n/phonenumbers/demo.js`.
### Compile

3. Compile the demo.js and all its dependencies to one file: `demo-compiled.js`:
`ant -f javascript/build.xml compile-demo`
```sh
sh scripts/execute.sh
```

3. Run the compiled demo: `javascript/i18n/phonenumbers/demo-compiled.html`
## Contributors

# Contributors :
[![@superhit0](https://avatars.githubusercontent.com/superhit0?size=50)](https://github.com/superhit0) | [![@patw0929](https://avatars.githubusercontent.com/patw0929?size=50)](https://github.com/patw0929) | [![@nutboltu](https://avatars.githubusercontent.com/nutboltu?size=50)](https://github.com/nutboltu)
----|-----|-----

0 comments on commit cea625a

Please sign in to comment.