Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move from submodules to secondary package.json #16

Open
leoj3n opened this issue Sep 25, 2017 · 0 comments
Open

Move from submodules to secondary package.json #16

leoj3n opened this issue Sep 25, 2017 · 0 comments

Comments

@leoj3n
Copy link
Contributor

leoj3n commented Sep 25, 2017

Submodules were a good way to get things organized for the first wave of sweeping changes but won't work so well for collaboration (most people don't know submodules) and, as it turns out, it's not possible to publish to npm from a git submodule:

canjs/canjs#3575

Therefore we will move to having a second package.json and a nested node_modules directory that will be used to store all the modules to be documented. This will be located at:

docs/modules/package.json

There will also be a .gitignore in that directory:

docs/modules/.gitignore

This will ignore the nested node_modules in that directory:

docs/modules/node_modules

In the main package.json, the bit-docs config will be updated from:

    "glob": {
      "pattern": "docs/**/*.{js,md,mustache,less}",
      "ignore": [
        "**/node_modules/**/*"
      ],
      "follow": true
    }

To:

    "glob": {
      "pattern": "docs/**/bit-docs*/*.{js,md,mustache,less}",
      "ignore": [
        "docs/modules/node_modules/**/node_modules/**/*"
      ],
      "follow": true
    }
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant