https://github.com/gianlucaguarini/package-requirejs

Generate a valid requirejs-config.js file automatically detecting all the package.json dependencies
https://github.com/gianlucaguarini/package-requirejs

Last synced: 2 days ago
JSON representation

Generate a valid requirejs-config.js file automatically detecting all the package.json dependencies

• Host: GitHub
• URL: https://github.com/gianlucaguarini/package-requirejs
• Owner: GianlucaGuarini
• License: mit
• Created: 2014-07-09T21:25:13.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-18T15:20:55.000Z (about 10 years ago)
• Last Synced: 2024-09-07T11:37:24.697Z (26 days ago)
• Language: JavaScript
• Size: 180 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
package-requirejs

=================

Generate a valid requirejs-config.js file automatically detecting all the package.json dependencies. It detects also dependencies namespaced in the file names to detect other possible dependencies to create the shim object.

### How to use

Install the package

```bash

$ sudo npm install package-requirejs -g

```

Trigger the following shell command from the the folder containing your package.json, being sure to have all your local dependencies already installed

```bash

$ package-requirejs

```

This command will generate a require-config.js file into the current folder.

#### Example

Having a `package.json` like the following

```json

{

  "name": "MyScript",

  "dependencies": {

    "backbone": "^1.1.2",

    "jquery": "^2.1.1",

    "nicescroll": "git+https://github.com/inuyaksa/jquery.nicescroll.git"

  }

}

```

`package-requirejs` will produce a requirejs-config.js file like this one

```javascript

requirejs.config({

  paths: {

    "underscore": "node_modules/backbone/node_modules/underscore/underscore",

    "backbone": "node_modules/backbone/backbone",

    "jquery": "node_modules/jquery/dist/jquery"

  },

  shim: {

    "backbone": [

      "underscore"

    ]

    "jquery.nicescroll": ['jquery']

  }

});

```

#### Options

You can pass your custom options to `package-requirejs` in the following order

 1. Output of the script - `requirejs-config.js` default

 2. Path to prepend to all the requirejs paths modules - `""` default

 4. Flag set to decide whether it must find the nested dependencies ( set it to `false` if your output file is a mess ) - `true` default

 3. Property in your package.json where the script can loop the dependencies installed - `"dependencies"` default

```bash

$ package-requirejs path/to/the/output/requirejs-config.js ../path/to/prepend/to/the/modules

```