https://github.com/erdembircan/git-submodule-preserve

preserve git sub-modules at static generated apps
https://github.com/erdembircan/git-submodule-preserve

git nuxt nuxt-module submodule

Last synced: 12 months ago
JSON representation

preserve git sub-modules at static generated apps

• Host: GitHub
• URL: https://github.com/erdembircan/git-submodule-preserve
• Owner: erdembircan
• License: mit
• Created: 2019-08-29T07:57:48.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T08:28:36.000Z (about 3 years ago)
• Last Synced: 2025-02-13T06:08:13.757Z (12 months ago)
• Topics: git, nuxt, nuxt-module, submodule
• Language: JavaScript
• Size: 514 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

  



# git-submodule-preserve [![Build Status](https://travis-ci.org/erdembircan/git-submodule-preserve.svg?branch=master)](https://travis-ci.org/erdembircan/git-submodule-preserve)

> nuxt module for preserving git submodule in generated static apps

## ❓ Why

By default `nuxt generate` command, which is responsible for creating static web apps, remove the entire target folder at regeneration. This may be an issue if you decided to split your source code from generated code and version/store them on seperate `git` repositories ([git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)). This module gives you the ability to preserve the `git submodule` at your production folder.

## 🖥 Usage

```bash

# install using your favourite package manager

npm install git-submodule-preserve -D

# or

yarn add git-submodule-preserve -D

```

> 💡 It is highly recommended to use this module under `buildModules` in your `nuxt.config.js` file and install as a `devDependency` for a faster production startup and smaller `node_modules` size.

## 📕 License

MIT

---

Erdem Bircan (c) 2019