https://github.com/adriancmiranda/proto
An extensible program-code-template for creating objects
https://github.com/adriancmiranda/proto
proto
Last synced: 21 days ago
JSON representation
An extensible program-code-template for creating objects
- Host: GitHub
- URL: https://github.com/adriancmiranda/proto
- Owner: adriancmiranda
- License: mit
- Created: 2014-07-26T02:20:42.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-08-21T15:20:58.000Z (about 1 month ago)
- Last Synced: 2025-09-09T07:57:46.107Z (26 days ago)
- Topics: proto
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/Proto
- Size: 2.1 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
> __Proto__ is an extensible program-code-template for creating objects
[![build status][travis_build_status_image]][travis_build_status_url]
[![dependencies status][david_dependencies_status_image]][david_dependencies_status_url]
[![devDependency status][david_devdependencies_status_image]][david_devdependencies_status_url]
[![Codacy Badge][codacy_status_image]][codacy_status_url]
[![License][shields_license_image]][shields_license_url]
[![NPM][nodei_status_image]][nodei_status_url]
[stability]: http://badges.github.io/stability-badges/dist/experimental.svg
[stability-url]: http://learnhtmlwithsong.com/blog/wp-content/uploads/2014/12/errors-everywhere-meme.png
[travis_build_status_image]: https://travis-ci.org/adriancmiranda/Proto.svg?branch=master
[travis_build_status_url]: https://travis-ci.org/adriancmiranda/Proto "build status"
[david_dependencies_status_image]: https://david-dm.org/adriancmiranda/Proto.svg?theme=shields.io
[david_dependencies_status_url]: https://david-dm.org/adriancmiranda/Proto "dependencies status"
[david_devdependencies_status_image]: https://david-dm.org/adriancmiranda/Proto/dev-status.svg?theme=shields.io
[david_devdependencies_status_url]: https://david-dm.org/adriancmiranda/Proto#info=devDependencies "devDependencies status"
[shields_license_image]: https://img.shields.io/badge/license-MIT-blue.svg
[shields_license_url]: https://github.com/adriancmiranda/Proto/blob/master/LICENSE.md
[codacy_status_image]: https://api.codacy.com/project/badge/Grade/75cc315f21fa4f3fa51b8fb0dfc36c67
[codacy_status_url]: https://www.codacy.com/app/adriancmiranda/Proto?utm_source=github.com&utm_medium=referral&utm_content=adriancmiranda/Proto&utm_campaign=Badge_Grade
[nodei_status_image]: https://nodei.co/npm/Proto.png?downloads=true&downloadRank=true&stars=true
[nodei_status_url]: https://nodei.co/npm/Proto/
[sample_img]: http://i.imgur.com/OXKG9od.png
[sample_url]: http://i.imgur.com/OXKG9od.png
What you need to build your own Proto
-----------------------------------------
In order to build Proto, you need to have the latest node/npm and git 1.7 or later. Earlier versions might work, but are not supported.
For Windows, you have to download and install [git](http://git-scm.com/downloads) and [node](http://nodejs.org/download/).
OS X users should install [git](http://git-scm.com/download).
Linux/BSD users should use their appropriate package managers to install git and node, or build from source
if you swing that way. Easy-peasy.
How to build your own Proto
-------------------------------
Clone a copy of the main Proto git repo by running:
```bash
git clone git://github.com/adriancmiranda/Proto.git
```
Enter the Proto directory and run the install script and the build script:
```bash
cd Proto && npm i && npm run build
```
The built version of Proto will be put in the `dist/` subdirectory, along with the minified copy and associated map file.
Get Started
-----------
## Installation
### Links to CDN
* [Proto.iife.js](https://rawgit.com/adriancmiranda/Proto/master/dist/Proto.iife.js) (18.7 KB)
* [Proto.iife.min.js](https://cdn.rawgit.com/adriancmiranda/Proto/master/dist/Proto.iife.min.js) (5.89 KB)
* [Proto.iife.min.js.map](https://cdn.rawgit.com/adriancmiranda/Proto/master/dist/Proto.iife.min.js.map) (108 Bytes)
* [Proto.iife.min.js.gz](https://cdn.rawgit.com/adriancmiranda/Proto/master/dist/Proto.iife.min.js.gz) (2.31 KB)
Use this URL for dev/testing
```html
```
Use this URL in production
```html
```
### via JSPM
`jspm install adriancmiranda/Proto`
### via Bower
`bower install adriancmiranda/Proto`
### via NPM
`npm i -D Proto`
### via Component
`component install adriancmiranda/Proto`
### Node/Browserify/Webpack
```javascript
var Proto = require('Proto');
```
Usage
-----
```javascript
var Ninja = Proto.extends({
// Objects doesn't affect implementations.
defaults:{
ninjateste:'**'
},
kill:function(flush){
console.log('kill '+ flush);
flush && this.flush();
}
});
var Human = Proto.extends({
constructor:function(){
console.log('i r human', this.$protoID);
this.super();
this.option();
}
});
var ChuckNorris = Human.extends({
defaults:{
skills:'ninja'
},
implements:[Ninja],
constructor:function(){
console.log('i r badass and.. ', this.$protoID);
this.super();
this.kill('with thumb');
},
rise:3
});
var Goku = ChuckNorris.extends({
defaults:{
superpowers:['unknown']
},
constructor:function(){
console.log('Hello! I\'m goku and.. ', this.$protoID);
this.super();
},
rise:function(){ // override rise property
console.log('wait for', this.super(), 'days...'); // super returns rise property from superclass
return this.super();
}
});
var chuck = new ChuckNorris();
chuck.kill('again!');
console.log('chuck:', chuck instanceof Proto); // true
console.log('chuck:', chuck instanceof Ninja); // false
console.log('chuck:', chuck instanceof Human); // true
console.log('chuck:', chuck instanceof ChuckNorris); // true
console.log('chuck.options:', chuck.options);
console.log('chuck:', chuck);
var goku = new Goku();
goku.rise();
console.log('goku:', goku);
```
[![Sample][sample_img]][sample_url]
See this usage [here](http://output.jsbin.com/kehate "You'll need open the browser console to see him in action"). You'll need open the browser console to see him in action.
# A real world sample
[plnkr](https://plnkr.co/edit/94qIJj?p=preview)
## License
[MIT](https://github.com/adriancmiranda/Proto/blob/master/LICENSE.md)