Organize the badges and boilerplates (#22)

* Organize the badge collection
* Use the boilerplate utility to stamp file headers. See https://github.com/paulhuggett/boilerplate

.boilerplate.txt

@@ -0,0 +1,4 @@
+Distributed under the Apache License v2.0.
+See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
+for license information.
+SPDX-License-Identifier: Apache-2.0

.boilerplateignore

@@ -0,0 +1,2 @@
+include/peejay/cprun.hpp
+include/peejay/icubaby.hpp

CMakeLists.txt

@@ -6,12 +6,10 @@
 #*  \____|_|  |_|\__,_|_|\_\___|_____|_|___/\__|___/ *
 #*                                                   *
 #===----------------------------------------------------------------------===//
-#
 # Distributed under the Apache License v2.0.
 # See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 # for license information.
 # SPDX-License-Identifier: Apache-2.0
-#
 #===----------------------------------------------------------------------===//
 cmake_minimum_required (VERSION 3.13)
 

README.adoc

@@ -2,13 +2,25 @@
 JSON Parser for C++
 :toc:
 
-image:https://github.com/paulhuggett/peejay/actions/workflows/ci.yaml/badge.svg[CI Build & Test,link=https://github.com/paulhuggett/peejay/actions/workflows/ci.yaml]
-image:https://sonarcloud.io/api/project_badges/measure?project=paulhuggett_peejay&metric=alert_status[Quality Gate, link=https://sonarcloud.io/summary/new_code?id=paulhuggett_peejay]
-image:https://app.codacy.com/project/badge/Grade/a37157bbd85c440daadd8039cda137b2[Codacy Badge, link=https://app.codacy.com/gh/paulhuggett/peejay/dashboard]
-image:https://github.com/paulhuggett/peejay/actions/workflows/klee.yaml/badge.svg[KLEE Tests,link=https://github.com/paulhuggett/peejay/actions/workflows/klee.yaml]
+== Status
+
+[cols="2,1"]
+|===
+| Continuous Integration 
+| image:https://github.com/paulhuggett/peejay/actions/workflows/ci.yaml/badge.svg[CI Build & Test,link=https://github.com/paulhuggett/peejay/actions/workflows/ci.yaml]
+
+| Static Analysis
+| image:https://sonarcloud.io/api/project_badges/measure?project=paulhuggett_peejay&metric=alert_status[Quality Gate, link=https://sonarcloud.io/summary/new_code?id=paulhuggett_peejay] image:https://app.codacy.com/project/badge/Grade/a37157bbd85c440daadd8039cda137b2[Codacy Badge, link=https://app.codacy.com/gh/paulhuggett/peejay/dashboard]
 image:https://img.shields.io/coverity/scan/28476.svg[Coverity Scan Build Status,link=https://scan.coverity.com/projects/paulhuggett-peejay]
 image:https://github.com/paulhuggett/peejay/actions/workflows/msvc.yaml/badge.svg[Microsoft C++ Code Analysis,link=https://github.com/paulhuggett/peejay/actions/workflows/msvc.yaml]
-image:https://www.bestpractices.dev/projects/8006/badge[OpenSSF Best Practices,link=https://www.bestpractices.dev/projects/8006]
+
+| Dynamic Analysis
+| image:https://github.com/paulhuggett/peejay/actions/workflows/klee.yaml/badge.svg[KLEE Tests,link=https://github.com/paulhuggett/peejay/actions/workflows/klee.yaml]
+
+| https://openssf.org[Open SSF]
+| image:https://www.bestpractices.dev/projects/8006/badge[OpenSSF Best Practices,link=https://www.bestpractices.dev/projects/8006]
+image:https://api.securityscorecards.dev/projects/github.com/paulhuggett/peejay/badge[OpenSSF Scorecard,link=https://securityscorecards.dev/viewer/?uri=github.com/paulhuggett/peejay]
+|=== 
 
 == Introduction
 

cprun/parse.py

@@ -7,12 +7,10 @@
 # * | .__/ \__,_|_|  |___/\___| *
 # * |_|                         *
 # ===----------------------------------------------------------------------===//
-#
 #  Distributed under the Apache License v2.0.
 #  See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 #  for license information.
 #  SPDX-License-Identifier: Apache-2.0
-#
 # ===----------------------------------------------------------------------===//
 """
 This module is used to generate the table of Unicode code point categories

cprun/unicode_data.py

@@ -7,12 +7,10 @@
 # *  \__,_|_| |_|_|\___\___/ \__,_|\___|  \__,_|\__,_|\__\__,_| *
 # *                                                             *
 # ===----------------------------------------------------------------------===//
-#
 #  Distributed under the Apache License v2.0.
 #  See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 #  for license information.
 #  SPDX-License-Identifier: Apache-2.0
-#
 # ===----------------------------------------------------------------------===//
 """This module decodes the contents of UnicodeData.txt (from from
 <https://www.unicode.org/Public/zipped/15.0.0/UCD.zip>.

include/peejay/arrayvec.hpp

@@ -6,12 +6,10 @@
 //*  \__,_|_|  |_|  \__,_|\__, | \_/ \___|\___| *
 //*                       |___/                 *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file arrayvec.hpp
 /// \brief Provides a sequence container, arrayvec<>. that encapsulates

include/peejay/cbii.hpp

@@ -6,12 +6,10 @@
 //*  \___|_.__/|_|_| *
 //*                  *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file cbii.hpp
 /// \brief Provides peejay::checked_back_insert_iterator is an output

include/peejay/details/avbase.hpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/ |_.__/ \__,_|___/\___| *
 //*                                    *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #ifndef PEEJAY_DETAILS_AVBASE_HPP
 #define PEEJAY_DETAILS_AVBASE_HPP

include/peejay/dom.hpp

@@ -6,12 +6,10 @@
 //*  \__,_|\___/|_| |_| |_| *
 //*                         *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file dom.hpp
 /// \brief Provides a simple document-object-module backend for the PJ JSON

include/peejay/emit.hpp

@@ -6,12 +6,10 @@
 //*  \___|_| |_| |_|_|\__| *
 //*                        *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file emit.hpp
 /// \brief The function peejay::emit() recursively writes a peejay::element

include/peejay/json.hpp

@@ -6,12 +6,10 @@
 //*  _/ |___/\___/|_| |_| *
 //* |__/                  *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file json.hpp
 /// \brief  Implements the PJ JSON Parser.

include/peejay/json_error.hpp

@@ -6,12 +6,10 @@
 //*  _/ |___/\___/|_| |_|  \___|_|  |_|  \___/|_|    *
 //* |__/                                             *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file json_error.hpp
 /// \brief Defines the errors that can be returned from the PJ library.

include/peejay/null.hpp

@@ -6,12 +6,10 @@
 //* |_| |_|\__,_|_|_| *
 //*                   *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 
 /// \file null.hpp

include/peejay/pointer_based_iterator.hpp

@@ -12,12 +12,10 @@
 //* |_|\__\___|_|  \__,_|\__\___/|_|    *
 //*                                     *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file pointer_based_iterator.hpp
 /// \brief Provides peejay::pointer_based_iterator: an iterator wrapper for

include/peejay/portab.hpp

@@ -6,12 +6,10 @@
 //* | .__/ \___/|_|   \__\__,_|_.__/  *
 //* |_|                               *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file portab.hpp
 /// \brief A collection of definitions which provide portability between

include/peejay/small_vector.hpp

@@ -6,12 +6,10 @@
 //* |___/_| |_| |_|\__,_|_|_|   \_/ \___|\___|\__\___/|_|    *
 //*                                                          *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file small_vector.hpp
 /// \brief Provides a small, normally stack allocated, buffer but which can be

include/peejay/stack.hpp

@@ -6,12 +6,10 @@
 //* |___/\__\__,_|\___|_|\_\ *
 //*                          *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file stack.hpp
 /// \brief Provides peejay::stack, a clone of std::stack but with iterator

include/peejay/uinteger.hpp

@@ -6,12 +6,10 @@
 //*  \__,_|_|_| |_|\__\___|\__, |\___|_|    *
 //*                        |___/            *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 /// \file uinteger.hpp
 /// \brief Provides peejay::uinteger which yields the smallest unsigned

klee/CMakeLists.txt

@@ -6,12 +6,10 @@
 #*  \____|_|  |_|\__,_|_|\_\___|_____|_|___/\__|___/ *
 #*                                                   *
 #===----------------------------------------------------------------------===//
-#
 # Distributed under the Apache License v2.0.
 # See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 # for license information.
 # SPDX-License-Identifier: Apache-2.0
-#
 #===----------------------------------------------------------------------===//
 function (klee_is_available result)
   find_program (KLEE_PATH klee)

klee/av_assign_count.cpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/    \__,_|___/___/_|\__, |_| |_|  \___\___/ \__,_|_| |_|\__| *
 //*                                |___/                                    *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_assign_range.cpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/    \__,_|___/___/_|\__, |_| |_| |_|  \__,_|_| |_|\__, |\___| *
 //*                                |___/                         |___/       *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_ctor_count.cpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/    \___|\__\___/|_|     \___\___/ \__,_|_| |_|\__| *
 //*                                                                *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_ctor_count_value.cpp

@@ -12,12 +12,10 @@
 //*   \_/ \__,_|_|\__,_|\___| *
 //*                           *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_ctor_first_last.cpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/    \___|\__\___/|_|    |_| |_|_|  |___/\__| |_|\__,_|___/\__| *
 //*                                                                           *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_emplace_pos_args.cpp

@@ -12,12 +12,10 @@
 //*  \__,_|_|  \__, |___/ *
 //*            |___/      *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_erase_first_last.cpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/    \___|_|  \__,_|___/\___| |_| |_|_|  |___/\__| |_|\__,_|___/\__| *
 //*                                                                                *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cassert>
 #include <cstddef>

klee/av_erase_pos.cpp

@@ -6,12 +6,10 @@
 //*  \__,_| \_/    \___|_|  \__,_|___/\___| | .__/ \___/|___/ *
 //*                                         |_|               *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_insert_pos_count_lvalue.cpp

@@ -12,12 +12,10 @@
 //*  \___\___/ \__,_|_| |_|\__| |_| \_/ \__,_|_|\__,_|\___| *
 //*                                                         *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>
 

klee/av_insert_pos_first_last.cpp

@@ -12,12 +12,10 @@
 //* |_| |_|_|  |___/\__| |_|\__,_|___/\__| *
 //*                                        *
 //===----------------------------------------------------------------------===//
-//
 // Distributed under the Apache License v2.0.
 // See https://github.com/paulhuggett/peejay/blob/main/LICENSE.TXT
 // for license information.
 // SPDX-License-Identifier: Apache-2.0
-//
 //===----------------------------------------------------------------------===//
 #include <cstddef>