meta:

  • name: keywords content: 前端小峰哥,前端规范化大纲,前端项目规范,前端编辑器规范,前端代码规范,前端样式规范
  • name: description content: 前端小峰哥学习笔记,今天给大家分享的是前端规范化学习笔记大纲,内容包括前端项目规范部分,包含gitignore文件,package.json文件和README.md文件规范;第二部分是编辑器规范,包括EditorConfig文件和Prettier插件;第三步部分是代码规范,包含html,css规范以及js代码规范,使用的工具是ESLint和StyleLint。

前端规范化

TIP

最后更新时间:2019年09月19日

字数:2201

前端规范化

  • 项目规范

    • gitignore

      • git代码管理文件忽略规范
    • package.json

      • 项目各种模块,项目信息配置文件
      • npm
        • 什么是npm
        • npm基本使用
      • package.json
        • package.json作用
        • 创建package.json
      • package.json解析
        • name
        • version
        • description
        • keywords
        • homepage
        • bugs
        • license
        • author
        • contributors
        • file
        • main
        • bin
        • man
        • directories
        • repository
        • scripts
        • config
        • dependencies(生产)
        • devDependencies(开发)
        • peerDependencies
        • bundledDependencies
        • optionalDependencies
        • engines
        • engineStrict
        • OS
        • cpu
        • preferGlobal
        • Private
        • publishConfig
    • README.md

      • 项目介绍文件

      • README.md文件作用

      • README.md文件命名规范

      • README.md文件内容规范

        • 项目背景介绍

        • 项目基本介绍

        • 项目开发环境

        • 项目启动或者使用说明(重要)

        • 项目API参考(重要)

        • 项目功能描述(重要)

        • 项目结构简介(内部项目)

          • 项目一些配置文件说明
          • 项目重要代码文件说明
          • 项目敏感文件说明
        • 测试DEMO

        • 项目测试运行效果

        • 作者列表

        • 更新链接

        • 历史版本

        • 联系方式

        • 开源协议

  • 编辑器规范

    • EditorConfig
      • 编辑器配置文件
    • Prettier
      • 代码格式化工具
  • 代码规范

    • html和css规范
      • HTMLHint
        • 用于HTML代码的静态检查
      • CSSLint
        • 用于CSS代码的静态检查
      • stylelint
        • 强大的CSS审查工具(重点)
  • JavaScript规范

    • JSLint
    • JSHint
    • JSCS
    • ESLint
      • 新一代代码规范工具(重点)