# @schauer/sp-sync

> Sync app output directory to SharePoint Site Assets

Latest version **1.0.20** (published 2020-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @schauer/sp-sync
pnpm add @schauer/sp-sync
yarn add @schauer/sp-sync
bun add @schauer/sp-sync
```

Provides the command `sp-sync`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.20 |
| Published | 2020-01-14 |
| First published | 2019-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 38.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matt Schauer |
| Maintainers | schauer |
| Keywords | SharePoint |

## Links

- npm: https://www.npmjs.com/package/@schauer/sp-sync
- Repository: https://github.com/mschauer5/sp-sync
- Homepage: https://github.com/mschauer5/sp-sync#readme
- Issues: https://github.com/mschauer5/sp-sync/issues
- npm.io page: https://npm.io/package/@schauer/sp-sync

## Dependencies (5)

- [yargs](https://npm.io/package/yargs.md) ^15.0.2
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [md5-file](https://npm.io/package/md5-file.md) ^4.0.0
- [@schauer/sp-repos](https://npm.io/package/@schauer/sp-repos.md) ^1.1.33

## Recent versions

- 1.0.20 (latest) — 2020-01-14
- 1.0.18 — 2020-01-14
- 1.0.17 — 2020-01-14
- 1.0.16 — 2020-01-14
- 1.0.15 — 2020-01-14
- 1.0.14 — 2020-01-14
- 1.0.13 — 2020-01-14
- 1.0.12 — 2020-01-04
- 1.0.11 — 2020-01-04
- 1.0.10 — 2020-01-04
- 1.0.9 — 2020-01-04
- 1.0.8 — 2020-01-04
- 1.0.7 — 2020-01-04
- 1.0.6 — 2020-01-04
- 1.0.5 — 2020-01-04
- … 5 more at https://npm.io/package/@schauer/sp-sync/versions

## README

# sp-sync

This is a nodejs app that will sync your output directory from your project on your local computer to SharePoint Site Assets library. Used for speeding up writing javascript apps and pushing it to a SharePoint Library

## Configurations

Example for development environment:

- Create an .env.development file in the root of the project directory.
- If VUE APP: prefix = VUE
- If REACT APP: prefix = REACT

## Edit .env.development file

- add {prefix}\_APP_SITE_ASSETS_RELATIVE_URL=/sites/xxx/siteassets
- add {prefix}\_APP_VERSION=0
- add {prefix}\_APP_WEB_URL=https://yyy.sharepoint.com/sites/xxx
- add {prefix}\_APP_WEB_RELATIVE_URL=/sites/xxx
- add {prefix}\_APP_OUTDIR=./dist
- add {prefix}\_APP_Mode=development

## Edit package.json

- sp-sync --mode development --action stepversion

  - this increments the version # in the .env file

- sp-sync --mode development --action sync

  - this will take the files in the outdir and upload the {prefix}\_APP_SITE_ASSETS_RELATIVE_URL location in the .env file

under scripts for a vue app - example
"build:development": "sp-sync --mode development --action stepversion && vue-cli-service build --mode development && sp-sync --mode development --action sync"

## Installation

    npm install --save-dev @schauer/sp-sync

### Disclaimer

**THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**

---
_Source: https://npm.io/package/@schauer/sp-sync · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._