Иерархия файлов

Описывает структуру проекта.

Оглавление страницы:

Корневой каталог 

Исходная структура сборки выглядит следующим образом:

├── .babelrc
├── .editorconfig
├── .eslintcache
├── .eslintignore
├── .eslintrc.js
├── .gitattributes
├── .github
├── .gitignore
├── gulp
├── gulpfile.babel.js
├── .husky
├── package.json
├── package-lock.json
├── .prettierrc
├── .pug-lintrc
├── README.md
├── src
├── .stylelintignore
├── .stylelintrc
└── webpack.config.js

Каталоги 

Разберем значение каталогов:

  • .github - содержит github actions;
  • .husky - содержит скрипты и конфигурационные файлы, которые определяют, какие команды или скрипты должны выполняться на определенных хуках Git;
  • gulp - содержит gulp таски;
  • src - содержит исходные файлы поекта.

Файлы 

Разберем значение файлов:

  • .babelrc - конфигурационный файл для babel;
  • .editorconfig - конфигурационный файл содержит стилитические правила для редактора кода;
  • .eslintignore - конфигурационный файл содержит пути к каталогам которые не должен проверять JavaScript линтер;
  • .eslintrc - конфигурационный файл содержит правила JavaScript линтера;
  • .gitattributes - конфигурационный файл содержит определения настроек, связанных с обработкой файлов при работе с репозиторием;
  • .gitignore - конфигурационный файл содержит файлы и каталоги которые не должны сохраняться в репозитории;
  • .prettierrc - конфигурационный файл правил Prettier линтера;
  • .pug-lintrc.json - конфигурационный файл правил Pug линтера;
  • .stylelintignore - конфигурационный файл содержит пути к каталогам которые не должен проверять CSS линтер;
  • .stylelintrc.json - конфигурационный файл правил CSS линтера;
  • package.json - конфигурационный файл содержит описания метаданных и зависимостей проекта;
  • package-lock.json - конфигурационный файл содержит информацию о дереве зависимостей;
  • gulpfile.babel.js - содержит набор тасков которые участвуют в сборке проекта;
  • README.md - содержит описание сборки.

Каталог gulp 

Содержит таски сборки, разбитые на отдельные модули. Более подробное описание по каждому файлу каталога gulp можно будет найти в разделе Gulp.

├── config.js
└── tasks
  ├── assets.js
  ├── clear.js
  ├── favicons.js
  ├── images.js
  ├── prepare.js
  ├── pug.js
  ├── server.js
  ├── sprites.js
  ├── styles.js
  └── webpack.js

Каталог src 

Содержит исходные файлы сборки такие как изображения, шрифты, верстку, стили, скрипты. Более подробное описание по каждому разделу исходных файлов можно будет найти в разделах:

./src
├── assets
├── js
├── libs
├── pug
└── scss