Merge pull request #103 from cpp-best-practices/spell-check [skip ci]

Author: aminya

.cmake-format.yaml

@@ -10,126 +10,3 @@ markup:
   bullet_char: "*"
   enum_char: .
   enable_markup: false
-parse:
-  additional_commands:
-    project_options:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: project_options
-      kwargs:
-        CLANG_WARNINGS: 1
-        GCC_WARNINGS: 1
-        MSVC_WARNINGS: 1
-        CONAN_OPTIONS: +
-    catch_discover_tests:
-      pargs:
-        nargs: "*"
-        flags: []
-      kwargs:
-        OUTPUT_DIR: 1
-        OUTPUT_PREFIX: 1
-        OUTPUT_SUFFIX: 1
-        REPORTER: 1
-        TEST_PREFIX: 1
-    conan_add_remote:
-      pargs:
-        nargs: "*"
-        flags: []
-      kwargs:
-        INDEX: 1
-        NAME: 1
-        URL: 1
-    conan_cmake_install:
-      pargs:
-        nargs: "*"
-        flags: []
-      kwargs:
-        BUILD: +
-        INSTALL_FOLDER: 1
-        LOCKFILE: 1
-        LOCKFILE_NODE_ID: 1
-        LOCKFILE_OUT: 1
-        PATH_OR_REFERENCE: 1
-        REFERENCE: 1
-        REMOTE: 1
-        ENV: +
-        ENV_BUILD: +
-        ENV_HOST: +
-        GENERATOR: +
-        OPTIONS: +
-        OPTIONS_BUILD: +
-        OPTIONS_HOST: +
-        PROFILE: +
-        PROFILE_BUILD: +
-        PROFILE_HOST: +
-        SETTINGS: +
-        SETTINGS_BUILD: +
-        SETTINGS_HOST: +
-    cpmaddpackage:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: CPMAddPackage
-      kwargs: &id001
-        DOWNLOAD_COMMAND: 1
-        DOWNLOAD_NAME: 1
-        DOWNLOAD_NO_EXTRACT: 1
-        DOWNLOAD_ONLY: 1
-        FIND_PACKAGE_ARGUMENTS: 1
-        FORCE: 1
-        GITHUB_REPOSITORY: 1
-        GITLAB_REPOSITORY: 1
-        GIT_REPOSITORY: 1
-        GIT_SHALLOW: 1
-        GIT_TAG: 1
-        HTTP_PASSWORD: 1
-        HTTP_USERNAME: 1
-        NAME: 1
-        NO_CACHE: 1
-        SOURCE_DIR: 1
-        SVN_REPOSITORY: 1
-        SVN_REVISION: 1
-        URL: 1
-        URL_HASH: 1
-        URL_MD5: 1
-        VERSION: 1
-        OPTIONS: +
-    cpmfindpackage:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: CPMFindPackage
-      kwargs: *id001
-    cpmdeclarepackage:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: CPMDeclarePackage
-      kwargs: *id001
-    packageproject:
-      pargs:
-        nargs: "*"
-        flags: []
-      spelling: packageProject
-      kwargs:
-        BINARY_DIR: 1
-        COMPATIBILITY: 1
-        DISABLE_VERSION_SUFFIX: 1
-        EXPORT_HEADER: 1
-        INCLUDE_DESTINATION: 1
-        INCLUDE_DIR: 1
-        NAME: 1
-        NAMESPACE: 1
-        VERSION: 1
-        VERSION_HEADER: 1
-        DEPENDENCIES: +
-    cpmusepackagelock:
-      pargs: 1
-      spelling: CPMUsePackageLock
-    cpmregisterpackage:
-      pargs: 1
-      spelling: CPMRegisterPackage
-    cpmgetpackageversion:
-      pargs: 2
-      spelling: CPMGetPackageVersion

Taskfile.yml

@@ -38,6 +38,7 @@ tasks:
       {{end}}
 
     - ~/vcpkg/vcpkg format-manifest ./test/vcpkg.json ./test_install/vcpkg.json
+    - npx -y cspell lint --no-progress --show-suggestions
 
   clean: |
     {{if eq OS "windows"}} 

cspell.config.yaml

@@ -0,0 +1,103 @@
+version: "0.2"
+files:
+  - "**/*"
+ignorePaths:
+  - pnpm-lock.yaml
+  - .git/
+  - dist/
+useGitignore: true
+language: en, en-GB
+allowCompoundWords: true
+enableGlobDot: true
+words:
+  - aarch
+  - aminya
+  - anotherproj
+  - applellvm
+  - ARGN
+  - asan
+  - buildtools
+  - ccache
+  - ccmake
+  - choco
+  - cmake
+  - cmakelint
+  - cmds
+  - cond
+  - CPATH
+  - Cppcheck
+  - cppcoreguidelines
+  - CPPFLAGS
+  - cpprc
+  - ctest
+  - Cuda
+  - DCMAKE
+  - deps
+  - DOPT
+  - dyld
+  - dylib
+  - Eigen
+  - fargs
+  - fcolor
+  - fdiagnostics
+  - ftime
+  - gcovr
+  - Graphviz
+  - hwrap
+  - kcov
+  - LDFLAGS
+  - libc
+  - libcuda
+  - libstdc
+  - LPSTR
+  - LPWSTR
+  - mdfile
+  - msbuild
+  - msvc
+  - msys
+  - multilib
+  - mylib
+  - myprogram
+  - myproj
+  - myproject
+  - nothrow
+  - nvcc
+  - Opencppcoverage
+  - pargs
+  - pnpm
+  - pwsh
+  - rmrf
+  - rpath
+  - sccache
+  - setx
+  - shlib
+  - suppr
+  - TOLOWER
+  - ubsan
+  - vcpkg
+  - vcvarsall
+  - visualc
+  - visualcpp
+  - VSCMD
+  - VSINSTALLDIR
+  - vsversion
+  - Wcast
+  - Wconversion
+  - Wdouble
+  - Wduplicated
+  - Werror
+  - Weverything
+  - Wextra
+  - Wformat
+  - Wlogical
+  - Wmisleading
+  - Wnon
+  - Wnull
+  - Woverloaded
+  - Wpedantic
+  - Wshadow
+  - Wsign
+  - Wunused
+  - Wuseless
+  - xcrun
+  - Yahyaabadi

src/Conan.cmake

@@ -19,10 +19,17 @@ macro(run_conan)
   # Add (or remove) remotes as needed
   # conan_add_remote(NAME conan-center URL https://conan.bintray.com)
   conan_add_remote(
-    NAME cci
-    URL https://center.conan.io
-    INDEX 0)
-  conan_add_remote(NAME bincrafters URL https://bincrafters.jfrog.io/artifactory/api/conan/public-conan)
+    NAME
+    cci
+    URL
+    https://center.conan.io
+    INDEX
+    0)
+  conan_add_remote(
+    NAME
+    bincrafters
+    URL
+    https://bincrafters.jfrog.io/artifactory/api/conan/public-conan)
 
   # For multi configuration generators, like VS and XCode
   if(NOT CMAKE_CONFIGURATION_TYPES)
@@ -43,13 +50,19 @@ macro(run_conan)
     # the external "conanfile.py" provided with the project
     # Alternatively a conanfile.txt could be used
     conan_cmake_install(
-      PATH_OR_REFERENCE ${CMAKE_SOURCE_DIR}
-      BUILD missing
+      PATH_OR_REFERENCE
+      ${CMAKE_SOURCE_DIR}
+      BUILD
+      missing
       # Pass compile-time configured options into conan
-      OPTIONS ${ProjectOptions_CONAN_OPTIONS}
+      OPTIONS
+      ${ProjectOptions_CONAN_OPTIONS}
       # Pass CMake compilers to Conan
-      ENV "CC=${CMAKE_C_COMPILER}" "CXX=${CMAKE_CXX_COMPILER}"
-      SETTINGS ${settings})
+      ENV
+      "CC=${CMAKE_C_COMPILER}"
+      "CXX=${CMAKE_CXX_COMPILER}"
+      SETTINGS
+      ${settings})
   endforeach()
 
 endmacro()