Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stealjs/steal
Gets JavaScript
https://github.com/stealjs/steal
amd build-tool commonjs javascript module-bundler module-loader plugins stealjs web
Last synced: 3 days ago
JSON representation
Gets JavaScript
- Host: GitHub
- URL: https://github.com/stealjs/steal
- Owner: stealjs
- License: mit
- Created: 2010-02-08T00:22:42.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T10:15:36.000Z (over 1 year ago)
- Last Synced: 2024-10-29T15:38:38.361Z (3 months ago)
- Topics: amd, build-tool, commonjs, javascript, module-bundler, module-loader, plugins, stealjs, web
- Language: JavaScript
- Homepage: https://stealjs.com
- Size: 65.8 MB
- Stars: 1,365
- Watchers: 40
- Forks: 521
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
- awesome - stealjs/steal - Gets JavaScript (JavaScript)
- awesome-github-repos - stealjs/steal - Gets JavaScript (JavaScript)
- awesome-github-star - steal
README
# steal
[](https://www.bitovi.com/community/slack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://forums.bitovi.com/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/stealjs/steal/blob/master/license.md)
[](https://www.npmjs.com/package/steal)
[](https://travis-ci.org/stealjs/steal)
[](https://greenkeeper.io/)
[](https://saucelabs.com/u/matthewphillips)
In addition to a collection of plugins, __StealJS__ is comprised of two main components:
- __`steal`__: an extensible, universal module loader.
- __`steal-tools`__: utilities for building, transforming, and exporting module formats.
This is the `steal` repository. For the `tools`, see .
## Module Loading with `steal`
`steal` is unique because it can load JavaScript modules defined in ES6, AMD, and CommonJS formats (unlike most other module loaders, which only support one of these formats at a time).
In JavaScript, the word "modules" refers to small units of independent, reusable code. They are the foundation of many JavaScript design patterns, and can look like this in ES6:
```js
export function hello() {
console.log('hello');
}
export function goodbye() {
console.log('goodbye');
}
```
Or like this in AMD:
```js
define([], function() {
return {
hello: function() {
console.log('hello');
},
goodbye: function() {
console.log('goodbye');
}
};
});
```
Or like this CommonJS:
```js
function hello() {
console.log('hello');
}
function goodbye() {
console.log('goodbye');
}
module.exports = {
hello: hello,
goodbye: goodbye
}
```
All of these formats are supported by `steal`, so you can mix and match modules in your project:
```js
// ES6
import { hello, goodbye } from "greetings";
// AMD
define(["greetings"],function(greetings){ ... });
// CommonJS
var hello = require('greetings').hello;
var goodbye = require('greetings').goodbye;
```
Additionally, plugins make it possible to load ANY module type you might come up with, such as Less or CSS. Anyone can write a plugin for `steal` to extend it's core module-loading functionality.
## Extending `steal` with Plugins
The StealJS organization maintains popular plugins that extend and enhance the module-loading capabilities of `steal` (and, subsequently, `steal-tools`) such as:
- [CSS](https://github.com/stealjs/steal-css)
- [Less](https://github.com/stealjs/steal-less)
- [Conditional](https://github.com/stealjs/steal-conditional)
- [Mocha](https://github.com/stealjs/steal-mocha)
- [QUnit](https://github.com/stealjs/steal-qunit)
For example, the Less plugin allows Less files to be loaded similarly to JavaScript modules:
```js
// ES6
import "style.less";
// AMD
define(["style.less"],function(){ ... });
// CommonJS
require("style.less");
// steal
steal("style.less")
```
Looking to create a plugin for another format? See [Writing Plugins](https://stealjs.com/docs/StealJS.writing-plugins.html).
For more information on StealJS, visit [StealJS.com](http://stealjs.com).
# Contributing
For information on contributing and developing, see the [Contributing Guide on StealJS.com](http://stealjs.com/docs/guides.Contributing.html).