https://github.com/lin3s/distribution

Distribution library for different purposes inside LIN3S
https://github.com/lin3s/distribution

composer distribution javascript npm php webpack

Last synced: 3 months ago
JSON representation

Distribution library for different purposes inside LIN3S

• Host: GitHub
• URL: https://github.com/lin3s/distribution
• Owner: LIN3S
• License: mit
• Created: 2015-07-24T15:45:18.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-27T14:54:08.000Z (over 6 years ago)
• Last Synced: 2024-10-08T12:36:37.301Z (4 months ago)
• Topics: composer, distribution, javascript, npm, php, webpack
• Language: JavaScript
• Size: 103 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LIN3S Distribution

> Distribution library for different purposes inside LIN3S.

[![Latest Stable Version](https://img.shields.io/github/release/lin3s/distribution.svg)](https://packagist.org/packages/lin3s/distribution)

Downloads from packagist (PHP):


[![Downloads from Packagist](https://img.shields.io/packagist/dt/lin3s/distribution.svg)](https://packagist.org/packages/lin3s/lin3s-distribution)

Downloads from NPM (JS):


[![Downloads from NPM](http://img.shields.io/npm/dt/lin3s-distribution.svg?style=flat)](https://www.npmjs.org/package/lin3s-distribution)

## Why?

In [LIN3S][1], we are working with many libraries and projects and usually all of them need scripts to

automate some process. This library centralize this kind of scripts and tasks improving its reusability.

## Installation

At this moment, this package contains *PHP* and *JavaScript* code, so you can manage this library from [NPM][3] and from [Composer][2].

If your project is in PHP, be sure that Composer is installed in your system and execute the following command:

```shell

$ composer require lin3s/distribution

```

Otherwise, if your project is in JavaScript, be sure that Node is installed in your system and execute the following command:

```shell

$ npm install lin3s-distribution --save-dev

#

# OR

#

$ yarn add lin3s-distribution --dev

```

## Usage

The following code is the basic configuration to make it work with **Webpack**.

```js

'use strict';

const Webpack = require('lin3s-distribution').Webpack;

const options = {

  entry: {

    'app': './app/Resources/assets/js/entry-app.js',

  },

  input: {

    base: 'app',

    scss: 'app/Resources/scss',

    includedNodeModules: [

      'swiper'

    ]

  },

  output: {

    jsPath: './web',

    jsPublicPath: '/',

    jsFilename: '[name].js',

    jsFilenameProduction: '[name].[chunkhash].js',

    cssPath: '',

    cssPublicPath: '/',

    cssFilename: '[name].css',

    cssFilenameProduction: '[name].[contenthash].css'

  },

  postcss: {

    autoprefixer: {

      browsers: ['last 2 versions']

    }

  },

  manifest: '../../manifest.json'

};

module.exports = Webpack(options);

```

## Symfony integration

Firstly, you need to install the bundle in your app kernel.

```php

// app/config/AppKernel.php

public function registerBundles()

{

    $bundles = [

        // ...

        new LIN3S\Distribution\Php\Symfony\Lin3sDistributionBundle(),

        // ...

    ];

}

```

Once the bundle has been enabled you can manage the configuration. The following is the default config:

```yml

# app/config/config.yml

lin3s_distribution:

    webpack:

        manifest_path: "%kernel.root_dir%/../manifest.json"

        public_js_path: "/js/"

        public_css_path: "/css/"

```

> Optionally you can enable the webpack default configuration doing this:

```yml

# app/config/config.yml

lin3s_distribution:

    webpack: ~

```

Finally replace your script and link html tags with the following Twig tags.

```twig

{# app/Resources/views/base.html.twig #}

(...)

(...)

    {% webpack_entry_css 'app' %}

(...)

    {% webpack_entry_js 'app' %}

```

## Licensing Options

[![License](https://poser.pugx.org/lin3s/distribution/license.svg)](https://github.com/LIN3S/Distribution/blob/master/LICENSE)

[1]: http://lin3s.com

[2]: https://getcomposer.org/

[3]: https://www.npmjs.com/