vyakymenko / qlik-sense-extensions-starter-pack

Lightweight Qlik Sense Extensions Starter Pack with TypeScript, esbuild, Tree-Shaking

Introduction

Qlik Sense Extensions Starter Pack provides fast, reliable and extensible starter for the development of QlikSense extensions.

Version

4.0.2

Tech

Qlik Sense Extensions Starter Pack uses a number of open source projects to work properly:

• Gulp - the streaming build system
• esbuild - awesome bundler

How to start

In order to start the qlik-sense-extensions-starter-pack use:

$ git clone --depth 1 https://github.com/vyakymenko/qlik-sense-extensions-starter-pack.git
$ cd qlik-sense-extensions-starter-pack

# install the project's dependencies
$ npm install

# develop and watches all your files
$ npm start

# production build with installers
$ npm run build

Table of Content

• Introduction
• Version
• Tech
• How to start
• Table of Content
• Configuration
• Examples
• Directory Structure
• License

Configuration

/**
 * Configuration
 */
export const Config: any = {
  src: {
    main: 'src/',
    extensions: 'src/Extensions/',
    ts: [
      'src/**/*.ts',
      'src/*.ts'
    ],
    scss: [
      'src/**/*.scss',
      'src/*.scss'
    ],
    assets: [
      'src/*.gif',
      'src/**/*.gif',
      'src/*.png',
      'src/**/*.png',
      'src/*.jpg',
      'src/**/*.jpg',
      'src/**/*.svg',
      'src/**/*.wbl',
      'src/*.wbl',
      'src/**/*.qext',
      'src/*.qext',
      'src/**/*.txt',
      'src/*.txt',
      'src/**/*.json',
      'src/*.json',
      'src/lib/*.js',
      'src/**/lib/*.js',
      'src/**/lib/**/*.js',
      'src/**/*.css',
      'src/*.css'
    ]
  },
  dist: {
    dev: 'dist/dev/',
    prod: 'dist/prod/'
  }
};

Examples

Test Extension

• Here is an example of extension with simple Log method.
• Source: TestExtension

Extension With Lib

• Here is an example of extension with simple Log method and Moment.js lib injection.
• Source: ExtensionWithLib

Directory Structure

├── LICENSE
├── README.md
├── gulpfile.ts
├── package-lock.json
├── package.json
├── src
│   ├── API
│   │   └── Util.ts
│   └── Extensions
│       ├── ExtensionWithAMD
│       │   ├── ExtensionWithAMD.qext
│       │   ├── ExtensionWithAMD.ts
│       │   ├── css
│       │   │   └── styles.scss
│       │   ├── lib
│       │   │   └── d3.min.js
│       │   └── wbfolder.wbl
│       ├── ExtensionWithLib
│       │   ├── ExtensionWithLib.qext
│       │   ├── ExtensionWithLib.ts
│       │   ├── css
│       │   │   └── styles.scss
│       │   ├── lib
│       │   │   └── moment.min.js
│       │   └── wbfolder.wbl
│       └── TestExtension
│           ├── TestExtension.qext
│           ├── TestExtension.ts
│           ├── css
│           │   └── styles.scss
│           └── wbfolder.wbl
├── tools
│   ├── config.ts
│   ├── tasks
│   │   ├── assets.copy.dev.ts
│   │   ├── assets.copy.prod.ts
│   │   ├── clean.dev.ts
│   │   ├── clean.prod.ts
│   │   ├── noop.ts
│   │   ├── scss.dev.ts
│   │   ├── scss.prod.ts
│   │   ├── ts.build.dev.ts
│   │   ├── ts.build.prod.ts
│   │   ├── tsconfig.json
│   │   ├── tslint.ts
│   │   └── watch.dev.ts
│   ├── tasks.json
│   └── utils
│       ├── code_change_tools.ts
│       ├── task.ts
│       └── tasks_tools.ts
├── tsconfig.json
└── tslint.json

License

MIT