mvps-cofigs

A collection of recommended development configuration files

In Progress

• Git
  • .gitconfig - Config | Info
  • .gitignore - Config | Info
  • .gitattributes - Config | Info
• Misc
  • .bashrc - Config | Info
  • .editorconfig - Config | Info
  • .npmrc - Config | Info
• Linters
  • ESlint - Config | Info
  • Stylelint - Config | Info
  • HTML Lint - Config | Info
  • Lint HTML - Config | Info

Todo

• PHP CodeSniffer

Installation & Setup

1. Show hidden files
2. Install Git
   1. Install Git LFS
3. Install Node & NPM & PNPM
   1. Configure npm to allow global installs without admin rights
   2. Check if you have pnpm installed: $ pnpm -v
   3. If the terminal outputs a version number, skip to step 5.
   4. Install pnpm: $ npm install -g pnpm
   5. $ pnpm install -g eslint babel-eslint postcss stylelint htmllint-cli @linthtml/linthtml
4. Download the config files
   1. $ cd ~/ && git clone https://github.com/mivaecommerce/mvps-configs.git
   2. $ cd mvps-configs && pnpm install
5. Install MAMP (or the following languages individually)
   1. Add the php, apache, python, mysql binaries to your PATH
   2. Install Composer
      1. Configure composer to allow global installs without admin rights?
      2. $ composer global require "squizlabs/php_codesniffer=*"
6. Optionally, install python, pip, & mkdocs (Coming Soon)
7. Install VS Code
   1. Install Miva IDE for syntax highlighting, snippets and tools for building websites with Miva.
      1. Miva IDE
   2. Install the language specific linter-packages
      1. ESLint
      2. Stylelint
      3. PHPCS
      4. PostCSS Sorting
      5. LintHTML
   3. Update your VS Code Settings, Command Prompt > Preferences Open Settings (JSON), and update them with settings indicated in vs-code.settings.json
8. Configure the linters to use the mvps-configs files.
   • This method is preferred because it supports unique linting settings for each repo you work with and it does not require configuring VS Code link at all.
   • Windows Users: Locate and update your ~/.bashrc file and append with export MSYS=winsymlinks:nativestrict to enable symlinking. Launch Git Bash as administrator and perform the following step's command.
   • Symlink the linter files in your mvps-configs directory to ~/ by running $ cd path/to/mvps-configs && pnpm run symlink:all then perform your development in any subfolder of ~/ (ex. ~/Documents/Development/Clients/www.example.com/)
9. Configure git init command to create repos based off of our config (which contains a git-hook to add Jira IDs to commits and set the default branch of new repos to main)
   1. git config --global init.templateDir ~/mvps-configs/git/templates
      • Note: You may need to change ~/ with the full path to where you cloned the mvps-configs repo (ex. C:\Users\username\mvps-configs\git/templates)