Luminous 开源项目使用教程

1. 项目的目录结构及介绍

Luminous 项目的目录结构如下：

luminous/
├── dist/
│   ├── luminous-basic.css
│   ├── luminous-basic.min.css
│   ├── luminous.css
│   ├── luminous.min.css
│   ├── luminous-basic.js
│   ├── luminous-basic.min.js
│   ├── luminous.js
│   └── luminous.min.js
├── src/
│   ├── css/
│   │   ├── luminous-basic.scss
│   │   └── luminous.scss
│   ├── js/
│   │   ├── Luminous.js
│   │   └── LuminousGallery.js
│   └── index.js
├── examples/
│   ├── basic/
│   ├── gallery/
│   └── index.html
├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

目录结构介绍

• dist/：包含编译后的 CSS 和 JavaScript 文件。
• src/：包含源代码文件，包括 CSS 和 JavaScript 文件。
• examples/：包含示例文件，展示如何使用 Luminous。
• .babelrc：Babel 配置文件。
• .editorconfig：编辑器配置文件。
• .eslintrc：ESLint 配置文件。
• .gitignore：Git 忽略文件配置。
• .npmignore：NPM 忽略文件配置。
• .travis.yml：Travis CI 配置文件。
• CONTRIBUTING.md：贡献指南。
• LICENSE：项目许可证。
• README.md：项目说明文档。
• package.json：NPM 包配置文件。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

Luminous 项目的启动文件是 src/index.js。这个文件是项目的入口点，负责初始化和导出 Luminous 和 LuminousGallery 模块。

// src/index.js

import Luminous from './js/Luminous';
import LuminousGallery from './js/LuminousGallery';

export { Luminous, LuminousGallery };

启动文件介绍

• src/index.js：导入并导出 Luminous 和 LuminousGallery 模块，作为项目的入口点。

3. 项目的配置文件介绍

Luminous 项目的配置文件主要包括 webpack.config.js 和 package.json。

webpack.config.js

webpack.config.js 是 Webpack 的配置文件，用于配置项目的构建过程。

// webpack.config.js

const path = require('path');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');

module.exports = {
  entry: {
    'luminous': './src/index.js',
    'luminous-basic': './src/index.js'
  },
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: '[name].min.js',
    library: 'Luminous',
    libraryTarget: 'umd',
    umdNamedDefine: true
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      },
      {
        test: /\.scss$/,
        use: [
          MiniCssExtractPlugin.loader,
          'css-loader',
          'sass-loader'
        ]
      }
    ]
  },
  plugins: [
    new MiniCssExtractPlugin({
      filename: '[name].min.css'
    })
  ]
};

package.json

package.json 是 NPM 包的配置文件，包含项目的基本信息、依赖项和脚本命令。

{
  "name": "luminous",
  "version": "2.3.4",
  "description": "A simple, lightweight, no-dependencies JavaScript