auto-check-element 项目教程

auto-check-element 项目教程

auto-check-elementAn input element that validates its value with a server endpoint.项目地址:https://gitcode.com/gh_mirrors/au/auto-check-element

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

auto-check-element/
├── dist/
│   ├── index.js
│   └── index.min.js
├── examples/
│   ├── basic.html
│   └── custom-validity.html
├── src/
│   ├── auto-check-element.js
│   └── index.js
├── test/
│   ├── auto-check-element.test.js
│   └── index.test.js
├── .gitignore
├── .npmignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

• dist/: 包含编译后的文件，index.js 和 index.min.js。
• examples/: 包含示例文件，如 basic.html 和 custom-validity.html。
• src/: 包含源代码文件，auto-check-element.js 和 index.js。
• test/: 包含测试文件，auto-check-element.test.js 和 index.test.js。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则。
• LICENSE: 许可证文件。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它导入了 auto-check-element.js 并将其注册为自定义元素。

import './auto-check-element.js';

3. 项目的配置文件介绍

• package.json: 包含了项目的依赖、脚本和其他元数据。

{
  "name": "@github/auto-check-element",
  "version": "1.0.0",
  "description": "An input element that validates its value with a server endpoint",
  "main": "dist/index.js",
  "module": "dist/index.js",
  "scripts": {
    "build": "webpack",
    "test": "jest"
  },
  "dependencies": {
    "lit-element": "^2.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.0",
    "webpack": "^4.0.0",
    "webpack-cli": "^3.0.0"
  },
  "license": "MIT"
}

• webpack.config.js: Webpack 配置文件，用于打包项目。

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'index.js'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  },
  mode: 'production'
};

以上是 auto-check-element 项目的基本教程，包含了项目的目录结构、启动文件和配置文件的介绍。

auto-check-elementAn input element that validates its value with a server endpoint.项目地址:https://gitcode.com/gh_mirrors/au/auto-check-element