Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added "files" to package.json (smaller footprint on NPM). Updated eslint. Added codeql. #10

Merged
merged 1 commit into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
name: "CodeQL"

on:
push:
branches: [ "release", "master" ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "release", "master" ]
schedule:
- cron: '38 4 * * 5'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
timeout-minutes: 360
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
# - name: Autobuild
# uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"

9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# Changelog

## [v4.2.3](https://github.com/neonexus/fixted/compare/v4.2.2...v4.2.3) (2023-11-02)

### Features

* Added "files" to `package.json`.
* Added `codeql-analysis.yml`.
* Updated dependencies.

## [v4.2.2](https://github.com/neonexus/fixted/compare/v4.2.1...v4.2.2) (2023-10-03)

### Features
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(The MIT License)

Copyright (c) 2022 NeoNexus DeMortis
Copyright (c) 2023 NeoNexus DeMortis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the 'Software'), to deal in the Software without restriction, including without limitation
Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,21 @@

Fixted is based on [Barrels](https://www.npmjs.com/package/barrels), by Ruslan Bredikhin.

For an example of real-world use, see this: https://github.com/neonexus/sails-react-bootstrap-webpack/blob/release/test/startTests.js#L145

[![npm](https://img.shields.io/npm/dm/fixted?logo=npm&style=plastic)](https://www.npmjs.com/package/fixted) [![Build Status](https://img.shields.io/travis/com/neonexus/fixted/master?style=plastic&logo=travis)](https://app.travis-ci.com/neonexus/fixted) [![npm (fixted)](https://img.shields.io/npm/v/fixted/latest?style=plastic&logo=npm)](https://www.npmjs.com/package/fixted) [![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/neonexus/fixted/master?style=plastic&logo=github)](https://github.com/neonexus/fixted)
[![npm](https://img.shields.io/npm/dm/fixted?logo=npm&style=plastic)](https://www.npmjs.com/package/fixted)
[![Build Status](https://img.shields.io/travis/com/neonexus/fixted/master?style=plastic&logo=travis)](https://app.travis-ci.com/neonexus/fixted)
[![NPM version](https://img.shields.io/npm/v/fixted/latest?style=plastic&logo=npm&label=latest)](https://www.npmjs.com/package/fixted)
[![GitHub version](https://img.shields.io/github/v/release/neonexus/fixted?style=plastic&logo=github&label=latest)](https://github.com/neonexus/fixted)
[<img src="mit.svg" width="95" height="18">](LICENSE)

## Installation

`npm i --save-dev fixted`
```console
npm i --save-dev fixted
```

## Real-World Usage Example

See [neonexus/sails-react-bootstrap-webpack](https://github.com/neonexus/sails-react-bootstrap-webpack/blob/release/test/startTests.js#L145) for an example of automated tests that depend on fake data.

## Usage

Expand Down
26 changes: 26 additions & 0 deletions mit.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 25 additions & 18 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fixted",
"version": "4.2.2",
"version": "4.2.3",
"description": "A simple way to populate Sails.js v1 models with data fixtures for testing purposes. Originally based on Barrels, by Ruslan Bredikhin.",
"keywords": [
"sails",
Expand All @@ -9,15 +9,17 @@
"testing",
"database",
"orm",
"waterline"
"waterline",
"fake",
"data"
],
"dependencies": {
"async": "~3.2.4",
"lodash": "~4.17.21"
},
"devDependencies": {
"chai": "~4.3.10",
"eslint": "~8.50.0",
"eslint": "~8.52.0",
"mocha": "~10.2.0",
"pre-commit": "~1.2.2",
"sails": "~1.5.8",
Expand All @@ -27,6 +29,9 @@
"peerDependencies": {
"sails": "1.x"
},
"files": [
"index.js"
],
"funding": [
{
"type": "github",
Expand Down