Google Git
Sign in
fuchsia / third_party / github.com / google / licenseclassifier / 926575c44bbc848f47f0e8b7b6a7d5f325a6ed3a
commit926575c44bbc848f47f0e8b7b6a7d5f325a6ed3a[log] [tgz]
authorGoogle Open Source <noreply+opensource@google.com>Mon Dec 13 15:51:00 2021 -0800
committerBill Neubauer <wcn@google.com>Wed Mar 16 15:36:54 2022 -0700
treecc8f0c6559142a443e4c95c53bbe2d4d2453b07e
parent9fc6ed6d865bf3329927b98d0da5591381969260 [diff]
Automated g4 rollback of changelist 415285962.

*** Reason for rollback ***

Crashing services with index out of bound (https://coroner.corp.google.com/#/crashes?user=compliance-presubmit3p)

*** Original change description ***

Fixes handling of newline characters so that Normalize preserves the newline
characters of the original input.

The code doing the tokenization of the newlines had some minor bugs that
resulted in spurious newlines being introduced into the token stream. This
wasn't a problem before since they were only used inside the tokenizer to
detect header constructs and de-hyphenate words, and were always removed from
the token stream passed to calling functions. This meant that the token stream
Normalize...

***

PiperOrigin-RevId: 416154051
3 files changed
tree: cc8f0c6559142a443e4c95c53bbe2d4d2453b07e
  1. commentparser/
  2. internal/
  3. licenses/
  4. serializer/
  5. stringclassifier/
  6. tools/
  7. v2/
  8. .travis.yml
  9. CHANGELOG
  10. classifier.go
  11. classifier_test.go
  12. CONTRIBUTING.md
  13. file_system_resources.go
  14. forbidden.go
  15. go.mod
  16. go.sum
  17. LICENSE
  18. license_type.go
  19. README.md
README.md

License Classifier

Build status

Introduction

The license classifier is a library and set of tools that can analyze text to determine what type of license it contains. It searches for license texts in a file and compares them to an archive of known licenses. These files could be, e.g., LICENSE files with a single or multiple licenses in it, or source code files with the license text in a comment.

A “confidence level” is associated with each result indicating how close the match was. A confidence level of 1.0 indicates an exact match, while a confidence level of 0.0 indicates that no license was able to match the text.

Adding a new license

Adding a new license is straight-forward:

  1. Create a file in licenses/.

    • The filename should be the name of the license or its abbreviation. If the license is an Open Source license, use the appropriate identifier specified at https://spdx.org/licenses/.
    • If the license is the “header” version of the license, append the suffix “.header” to it. See licenses/README.md for more details.

  2. Add the license name to the list in license_type.go.

  3. Regenerate the licenses.db file by running the license serializer:

    $ license_serializer -output licenseclassifier/licenses

  4. Create and run appropriate tests to verify that the license is indeed present.

Tools

Identify license

identify_license is a command line tool that can identify the license(s) within a file.

$ identify_license LICENSE
LICENSE: GPL-2.0 (confidence: 1, offset: 0, extent: 14794)
LICENSE: LGPL-2.1 (confidence: 1, offset: 18366, extent: 23829)
LICENSE: MIT (confidence: 1, offset: 17255, extent: 1059)

License serializer

The license_serializer tool regenerates the licenses.db archive. The archive contains preprocessed license texts for quicker comparisons against unknown texts.

$ license_serializer -output licenseclassifier/licenses

This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.