2.1.1

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: code.foss.global/host.today/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: code.foss.global/host.today/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -3,7 +3,6 @@
 # artifacts
 coverage/
 public/
-pages/
 
 # installs
 node_modules/
@@ -15,8 +14,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
-# custom
+#------# custom

.gitlab-ci.yml

@@ -1,119 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
-
-stages:
-- security
-- test
-- release
-- metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - priv
-
-testBuild:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install lts
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
-  stage: metadata
-  script:
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,61 +0,0 @@
-# @pushrocks/smartfm
-frontmatter done right
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfm)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfm)
-* [github.com (source mirror)](https://github.com/pushrocks/smartfm)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartfm/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartfm/badges/master/build.svg)](https://gitlab.com/pushrocks/smartfm/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartfm/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartfm/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartfm.svg)](https://www.npmjs.com/package/@pushrocks/smartfm)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartfm/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartfm)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-
-## Usage
-
-We recommend TypeScript for best in class Intellisense.
-
-```javascript
-import * as smartfm from * smartfm
-
-let markdownfile = `---
-testKey: testValue
-testKey2: testValue2
----
-# some markdown`
-
-// easy methods
-let parsedData = smartfm.parse(markdownfile)
-
-// parsedData will be object
-/*
-    {
-        data: {
-            testKey: testValue,
-            testKey2: testValue2
-        },
-        content: '# some markdown',
-        orig: '---\ntestKey: testValue\ntestKey2: testValue2\n---\n# some markdown'
-    }
-*/
-
-let newFmString = smartfm.stringify('My awesome string', {testKey1: testValue1})
-// newFmString will be '---\testKey1: testValue1\n---\nMyawesomeString'
-
-# class Smartfm
-let mySmartfm = new smartfm.Smartfm({
-    fmType: 'yaml' // can be yaml or json atm
-})
-```
-
-For further information read the linked docs at the top of this readme.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

changelog.md

@@ -0,0 +1,53 @@
+# Changelog
+
+## 2025-01-24 - 2.1.1 - fix(documentation)
+Improved and updated README with detailed usage instructions
+
+- Replaced placeholder text in README with complete usage guide
+- Added comprehensive examples for parsing and stringifying frontmatter data
+- Included detailed instructions on how to install and use the Smartfm class
+
+## 2025-01-23 - 2.1.0 - feat(ci)
+Introduce new CI workflows for Gitea and remove GitLab CI
+
+- Added .gitea/workflows/default_nottags.yaml and .gitea/workflows/default_tags.yaml for Gitea CI workflow.
+- Removed .gitlab-ci.yml indicating a shift from GitLab CI to Gitea CI.
+- Updated package.json to use updated repository URLs conforming to the new hosting strategy.
+- Updated README.md and npmextra.json with new npm package name and repository details.
+
+## 2024-04-01 - 2.0.4 - Maintenance
+Switch to a new organizational scheme and multiple updates to `npmextra.json`.
+
+- Updated `npmextra.json` multiple times for consistency with `githost`.
+- Switched to a new organization scheme.
+
+## 2019-09-04 - 2.0.1 to 2.0.4 - Core Updates
+Continual core updates to enhance stability.
+
+- Core updates implemented in versions 2.0.1, 2.0.2, and 2.0.3.
+
+## 2018-08-27 - 2.0.0 - Dependencies
+Significant updates in dependencies management.
+
+- Removed obsolete import of `typings-global`.
+- Introduction of the 2.x series with dependency fixes.
+
+## 2018-08-27 - 1.0.5 - BREAKING CHANGE
+Transition to a new organizational scope.
+
+- Switched to `@pushrocks` scope, marking a major change in project organization.
+
+## 2017-05-27 - 1.0.3 - 1.0.4 - Configuration Updates
+Enhancements in configuration and standards.
+
+- Added `npmextra.json`.
+- Updated CI YAML file.
+- Adopted latest project standards.
+
+## 2016-11-14 - 1.0.0 to 1.0.2 - Initial Release & Improvements
+Initial project release with subsequent improvements.
+
+- Initial working release.
+- Improved Readme for better user guidance.
+- Continuous updates to align with project standards.
+

npmextra.json

@@ -4,13 +4,32 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "smartfm",
-      "shortDescription": "frontmatter done right",
-      "npmPackagename": "@pushrocks/smartfm",
-      "license": "MIT"
+      "description": "A Node.js module for handling and processing frontmatter in markdown and text files, leveraging the gray-matter library for parsing and stringifying YAML or JSON formatted frontmatter.",
+      "npmPackagename": "@push.rocks/smartfm",
+      "license": "MIT",
+      "keywords": [
+        "frontmatter",
+        "markdown",
+        "text files",
+        "YAML",
+        "JSON",
+        "stringify",
+        "parse",
+        "commented sections",
+        "static site generator",
+        "CMS",
+        "content metadata",
+        "metadata management",
+        "gray-matter"
+      ]
     }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,44 +1,60 @@
 {
-  "name": "@pushrocks/smartfm",
-  "version": "2.0.2",
+  "name": "@push.rocks/smartfm",
+  "version": "2.1.1",
   "private": false,
-  "description": "frontmatter done right",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "description": "A Node.js module for handling and processing frontmatter in markdown and text files, leveraging the gray-matter library for parsing and stringifying YAML or JSON formatted frontmatter.",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "tsbuild"
+    "build": "tsbuild tsfolders --allowimplicitany",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartfm.git"
+    "url": "git+https://code.foss.global/push.rocks/smartfm.git"
   },
   "keywords": [
-    "frontmatter"
+    "frontmatter",
+    "markdown",
+    "text files",
+    "YAML",
+    "JSON",
+    "stringify",
+    "parse",
+    "commented sections",
+    "static site generator",
+    "CMS",
+    "content metadata",
+    "metadata management",
+    "gray-matter"
   ],
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/smartfm/issues"
+    "url": "https://code.foss.global/push.rocks/smartfm/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartfm#README",
+  "homepage": "https://code.foss.global/push.rocks/smartfm#readme",
   "dependencies": {
     "gray-matter": "^4.0.2"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@git.zone/tsbuild": "^2.1.17",
+    "@git.zone/tsrun": "^1.2.8",
+    "@git.zone/tstest": "^1.0.24",
+    "@push.rocks/tapbundle": "^5.5.6",
     "@types/node": "^12.7.4"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.hints.md

@@ -0,0 +1 @@
+ 

test/test.ts

@@ -1,6 +1,6 @@
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect } from '@push.rocks/tapbundle';
 
-import * as smartfm from '../ts/index';
+import * as smartfm from '../ts/index.js';
 
 let testSmartfm = new smartfm.Smartfm({ fmType: 'yaml' });
 tap.test('.parse()', async () => {
@@ -11,19 +11,35 @@ testKey2: testValue2
 # some markdown
 `;
   let parsedString = testSmartfm.parse(testString);
-  expect(parsedString.data).to.have.property('testKey', 'testValue');
-  expect(parsedString.data).to.have.property('testKey2', 'testValue2');
-  expect(parsedString.orig.toString()).to.equal(testString);
+  expect(parsedString.data).toHaveProperty('testKey', 'testValue');
+  expect(parsedString.data).toHaveProperty('testKey2', 'testValue2');
+  expect(parsedString.orig.toString()).toEqual(testString);
 });
 tap.test('should stringify data', async () => {
   let testStringPure = `# some markdown heading\nsome first row`;
   let testStringCombined = testSmartfm.stringify(testStringPure, { testData: 'hi' });
   let resultString = '---\ntestData: hi\n---\n# some markdown heading\nsome first row\n';
-  expect(resultString).to.equal(testStringCombined);
+  expect(resultString).toEqual(testStringCombined);
 });
 
 tap.test('should parse a normal frontmatter file', async () => {
-  
+  const normalFile = `---
+heythere: awesome
+---
+really 
+`;
+  let result = testSmartfm.parse(normalFile);
+  expect(result.data.heythere).toEqual('awesome');
+});
+
+tap.test('should parse a commented out frontmatter file', async () => {
+  const commentedFile = `# ---
+# heythere: awesome
+# ---
+really 
+`;
+  let result = testSmartfm.parseFromComments('# ', commentedFile);
+  console.log(result);
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartfm',
+  version: '2.1.1',
+  description: 'A Node.js module for handling and processing frontmatter in markdown and text files, leveraging the gray-matter library for parsing and stringifying YAML or JSON formatted frontmatter.'
+}

ts/index.ts

@@ -29,4 +29,17 @@ export class Smartfm {
   parse(stringToParse: string) {
     return grayMatter(stringToParse);
   }
+
+  /**
+   * parse from comments
+   */
+  parseFromComments(commentStart: string, stringToParse: string) {
+    const diffFunc = (diffMe, diffBy) => diffMe.split(diffBy).join('');
+    let lines = stringToParse.split('\n');
+    lines = lines.map((line) => {
+      return diffFunc(line, commentStart);
+    });
+    const cleanedString = lines.join('\n');
+    return this.parse(cleanedString);
+  }
 }

tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+    "baseUrl": ".",
+    "paths": {}
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}