https://github.com/marckassay/ionic-native-dev-util
Automates in creation of symbolic ionic-native plugin folder for development purposes
https://github.com/marckassay/ionic-native-dev-util
development-utility ionic-native-plugins symlink
Last synced: 3 months ago
JSON representation
Automates in creation of symbolic ionic-native plugin folder for development purposes
- Host: GitHub
- URL: https://github.com/marckassay/ionic-native-dev-util
- Owner: marckassay
- License: mit
- Created: 2019-01-14T19:39:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-18T14:33:53.000Z (over 6 years ago)
- Last Synced: 2025-03-12T15:34:37.046Z (3 months ago)
- Topics: development-utility, ionic-native-plugins, symlink
- Language: TypeScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ionic-native-dev-util
To assist in development with ionic-native plugins. When being developed concurrently with an app
that consumes an ionic-native plugin, ionic-native-dev-util creates a symbolic directory in the `node_modules/@ionic-native`
folder. And to fully complete this automation, it will modify the app's tsconfig.json and
angular.json files so that `preserveSymlinks` are set to `true`.
## Install
[](https://github.com/marckassay/ionic-native-dev-util/blob/master/LICENSE) [](https://www.npmjs.com/package/ionic-native-dev-util)
### npm
```shell
npm install ionic-native-dev-util --save-dev
```
### yarn
```shell
yarn add ionic-native-dev-util --dev
```
link: [yarnpkg.com/en/package/ionic-native-dev-util](https://yarnpkg.com/en/package/ionic-native-dev-util)
## Usage
The command below should of been added to host's package.json on 'postinstall' event. If not, add it.
```json
{
"scripts": {
"linkplugin": "node ./node_modules/ionic-native-dev-util"
}
}
```
You need to have access to the [ionic-native](https://github.com/ionic-team/ionic-native) 'dist'
folder. This is the build folder that contains all of its plugins which needs to be built post git
clone. And then, for an example, execute the following:
```shell
yarn run linkplugin /home/marc/repos/ionic-native/dist/@ionic-native/plugins/audio-management/
```
Where 'audio-management' is the name of the plugin folder. The 'linkplugin' command should of
created a symbolic directory in the `node_modules/@ionic-native` folder of the app, if there isn't a folder
created already with that name. Also if tsconfig.json and/or angular.json are at the root of the
app, 'linkplugin' command should of enabled the `preserveSymlinks` property.