# selectizer > Selectizer is a build tool made for Node.js that compile javascript projects. It allows to divide an entire project into small javascript files (modules) and then select what pieces of code to include in a specific build. Latest version **0.1.18** (published 2014-11-03) · MIT license · 0 weekly downloads ## Install ```sh npm install selectizer pnpm add selectizer yarn add selectizer bun add selectizer ``` Provides the command `selectizer`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.18 | | Published | 2014-11-03 | | First published | 2014-06-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | * | | Dependencies | 2 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 2 | | Author | Altman Quaranta Augusto | | Maintainers | augusto.altman, matiascarranza | | Keywords | modularization, modules, compile, build, dependencies, select, file selection, modules selection, build customization, cutomization, build tool | ## Links - npm: https://www.npmjs.com/package/selectizer - Repository: https://github.com/augusto-altman/selectizer - Issues: https://github.com/augusto-altman/selectizer/issues - npm.io page: https://npm.io/package/selectizer ## Dependencies (2) - [mkdirp](https://npm.io/package/mkdirp.md) ~0.3.4 - [requirejs](https://npm.io/package/requirejs.md) ~2.1.4 ## Alternatives - [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads - [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads - [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads - [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads - [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads ## Recent versions - 0.1.18 (latest) — 2014-11-03 - 0.1.17 — 2014-08-18 - 0.1.16 — 2014-08-17 - 0.1.15 — 2014-08-17 - 0.1.14 — 2014-08-08 - 0.1.12 — 2014-08-03 - 0.1.11 — 2014-08-03 - 0.1.10 — 2014-07-20 - 0.1.9 — 2014-07-20 - 0.1.8 — 2014-07-02 - 0.1.7 — 2014-06-30 - 0.1.6 — 2014-06-30 - 0.1.5 — 2014-06-29 - 0.1.4 — 2014-06-23 - 0.1.3 — 2014-06-23 - … 2 more at https://npm.io/package/selectizer/versions ## README Selectizer is deprecated! ============= We have developed a much stable, much usable, much maintainable tool called [AlbanilJS](https://github.com/augusto-altman/AlbanilJS). [AlbanilJS](https://github.com/augusto-altman/AlbanilJS) will replace Selectizer forever, so we won't mantain selectizer any more. If you find yourself here for the first time please go and try [AlbanilJS](https://github.com/augusto-altman/AlbanilJS) directly. If you are already using selectizer in your project please consider to migrate to [AlbanilJS](https://github.com/augusto-altman/AlbanilJS) Selectizer build tool ------------- Based on the [Modernizr](https://github.com/Modernizr/Modernizr) build process, Selectizer is a build tool made for [Node.js](http://nodejs.org/) that compile javascript projects. It allows the developer to divide an entire project into small javascript files (modules) and then select what pieces of code to include in a specific _build_, resolving the dependencies automatically (using the [Requirejs's optimization tool](http://requirejs.org/docs/optimization.html)). The final effect is to get all the selected files (and its dependencies) concatenated into one big deliverable javascript. This tool gives to the development process two great advantages: 1. The first one is that you can divide your entire project in small chunks of code located in separated files. So, in a way, Selectizer allows you to modularize you code. Ok, that's nice, but.. what about the dependecies? I mean, if you want to put all together some pieces of code into one big deliverable js, there must be a way to specify _the order_ in which these files are arranged, in other words to resolve the dependecies beteween that pieces of code. For this, each module must specify its dependecies, so that Selectizer can resolve them using r.js (the [Requirejs's optimization tool](http://requirejs.org/docs/optimization.html)). The syntax for specifiying the dependecies is the same as the requirejs. 2. The second one is that you can make custom builds, selecting the modules you want to include. Selectizer will create a final deliverable javascript file with only the specified modules and its dependecies. To specify the modules is needed a configuration file which sytax is detailed below. How to install it? ------------- It is avaible in [npm](https://www.npmjs.org/package/selectizer) ```shell $ npm install selectizer ``` Changes from previous versions ------------- * **Diff against 0.1.8**: * You can specify how to wrap your object through the _wrap_ option of an object's config json. * The paths are no longer relative to your project's root directory. Now the paths are relative to the _execution source_. * A bug was solved. The generation process was adding some semicolons to the final build. This is not happening anymore. * Now you can return the module you are exponsing as you normaly would do when using RequireJS. This allows you to write AMD unit tests by requiring this modules. * The examples were updated accordingly this changes. * The _dependencies_ property of an object's config json have changed his name to _modules_. How to use it? ------------- First of all, Selectizer works always with objects. This means that when you build something, you are building an object. This is because Selectizer wraps the selected modules and its dependecies into an [IIFE](http://benalman.com/news/2010/11/immediately-invoked-function-expression/) and exposes the object through a _window.OBJECT = OBJECT_ assignment. One important thing to mention is that, at this moment, there is one **big constrain** that will be solved in future revisions. When you build an object, you are only able to specify _internal dependecies_. So, for example if you want to build two objects, _A_ and _B_, and some modules of _A_ depends on some modules of _B_ these are considered _external dependencies_ and then there is no way to manage this kind of situations. You must load the entire _B_ object before _A_ as usually (of course that both of these objects could be builded separately using selectizer, buy you have to resolve the _external dependencies_ manually). This happens because Selectizer can build only one object at a time. That having said, you can use the Selectizer build tool from the comand line as well as a node module (using _require_). In both cases it recieves two arguments (specified in order): * **The name of the object you want to build (from now on _object folder_)**: Selectizer will always look for a folder named just as the object you want to build. Inside this folder must be a _config_ sub-folder from where Selectizer can obtain the configuration files, and a _src_ sub-folder with all the javascript files (modules) that composes the object. * **Tha path of a folder containing all the object folders**: Selectizer will look for any object folder inside this path. After you generate your build it will be located in the _build_ sub-folder of the object folder. Configurate ------------- The configuration files are a **key** part of the Selectizer build process. This is because through these configurations you can select the modules you want to include in a custom build. Also you can specify some fixed code to include always at the bottom of the build. So, there are two configuration files that must be always inside a sub-folder of your object folder, named _config_. These are: * **OBJECT.initCode.js**: Here you can specify some fixed code that will be always at the bottom of your IIFE's object definition. * **OBJECT.config.json**: Here you can select the modules you want to include for a specific custom build. The json itself is an object with two properties: * _modules_: An array of the modules you want to include in a specific build. * _wrap_: You should wrap your object inside of some kind of encapsulation machanism. In order to do this you have the _wrap_ property which is an object composed by two mandatory fields: * _start_: A string specifying the top of the object's wrapper. * _end_: A string specifying the bottom of the object's wrapper. * _paths_ (optional): An optional object where you can specify the path of some modules (relative to the _src_ folder). These feature was added to create aliases for the module's paths. Because to define a module you must use the [Requirejs](http://requirejs.org/docs/api.html#define) syntax, in each module you can specify their dependencies using its paths, but these is a problem if you decide to change the path of some module, because you will have to go into every dependant module and change it as well. With these system for _aliasing_ these problem is solved. But again, its use is only optional. Example ------------- As you can see the directory arrangment is very important in order to build effective projects. So lets define our properly set folder arrangment. . └── objs ├── A | ├── config | | ├── A.initCode.js | | └── A.config.json | └── src | ├── utils | | ├── ajaxPost.js | | └── ajaxGet.js | ├── restCommunication | | ├── callXApi.js | | └── callYApi.js | └── vars | └── a_.js └── B ├── config | ├── B.initCode.js | └── B.config.json └── src ├── helpers | └── parser.js ├── interpreter | ├── getCode.js | └── execute.js └── variables └── internalB.js I have created and commited this entire sample directory inside the _example_ folder of this repo, so download it, check it out, and follow the instructions below. You can play with it. For example, if you want to build the _A_ object using the command line, you should execute: ```shell $ cd [ProjectDirectory]/node_modules/.bin $ selectizer A ../selectizer/example/objs ``` Remember that, in node, to execute a command downloaded with _npm_, you must to execute it from _node\_modules/.bin_. If you want to use it as a node module then you should do this (supposing that you are saving this javascript file inside your project's root directory): ```JavaScript var gen = require('selectizer'); gen('A', 'node_modules/selectizer/example/objs'); ``` After execute this stuff you will find the build in _node_modules/selectizer/example/objs/A/build/A.js_ License ------------- Copyright (c) 2014 - 2014 Augusto Altman Quaranta and Matias Carraza et al Licensed under the MIT license. Contact us ------------- **e-mail**: augusto.altman@gmail.com, matiascarranza@gmail.com --- _Source: https://npm.io/package/selectizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._