Add basic usage example

examples/logger/.gitignore

@@ -0,0 +1,2 @@
+.stack-work/
+*~

examples/logger/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog for `logger-example`
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to the
+[Haskell Package Versioning Policy](https://pvp.haskell.org/).
+
+## Unreleased
+
+## 0.1.0.0 - YYYY-MM-DD

examples/logger/LICENSE

@@ -0,0 +1,30 @@
+Copyright Author name here (c) 2023
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Author name here nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

examples/logger/README.md

@@ -0,0 +1 @@
+# logger-example

examples/logger/Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

examples/logger/app.log

@@ -0,0 +1 @@
+Log message 10

examples/logger/app/Main.hs

@@ -0,0 +1,52 @@
+-- Enable the OverloadedStrings language extension to allow string literals
+-- to be interpreted as Text values from the Data.Text module.
+{-# LANGUAGE OverloadedStrings #-}
+
+-- Import necessary modules and libraries.
+import System.AtomicWrite.Writer.Text
+import qualified Data.Text as T
+import qualified Data.Text.IO as TIO
+import Control.Monad (forM_)
+import Control.Concurrent (forkIO, threadDelay)
+import System.FilePath ((</>))
+
+-- Define the file path where log messages will be stored.
+logFilePath :: FilePath
+logFilePath = "app.log"
+
+-- Function to log a message to a specified file.
+logMessage :: FilePath -> T.Text -> IO ()
+logMessage logFile message = atomicWriteFile logFile message
+
+-- Function to simulate a logging process by writing log messages to a file.
+simulateLoggingProcess :: FilePath -> IO ()
+simulateLoggingProcess logFile = do
+    forM_ [1..10] $ \i -> do
+        -- Create a log message as Text, incorporating the current value of 'i'.
+        let message = "Log message " <> T.pack (show i)
+        -- Log the message to the specified file.
+        logMessage logFile message
+        -- Print the message to the console for visibility.
+        putStrLn $ "Logged: " <> T.unpack message
+        -- Pause the execution for 1 second.
+        threadDelay 1000000
+
+main :: IO ()
+main = do
+    -- Clear the contents of the log file by writing an empty Text to it.
+    TIO.writeFile logFilePath ""
+
+    -- Fork a new thread to run the simulateLoggingProcess function concurrently.
+    _ <- forkIO (simulateLoggingProcess logFilePath)
+
+    -- Pause the main thread for 12 seconds to allow the logging process to run in the background.
+    threadDelay 12000000
+
+    -- Read the contents of the log file into a Text variable.
+    logContents <- TIO.readFile logFilePath
+
+    -- Print a header indicating the log file contents.
+    putStrLn "Log File Contents:"
+
+    -- Print the log file contents to the console.
+    TIO.putStrLn logContents

examples/logger/logger-example.cabal

@@ -0,0 +1,76 @@
+cabal-version: 2.2
+
+-- This file has been generated from package.yaml by hpack version 0.36.0.
+--
+-- see: https://github.com/sol/hpack
+
+name:           logger-example
+version:        0.1.0.0
+description:    Please see the README on GitHub at <https://github.com/githubuser/logger-example#readme>
+homepage:       https://github.com/githubuser/logger-example#readme
+bug-reports:    https://github.com/githubuser/logger-example/issues
+author:         Author name here
+maintainer:     [email protected]
+copyright:      2023 Author name here
+license:        BSD-3-Clause
+license-file:   LICENSE
+build-type:     Simple
+extra-source-files:
+    README.md
+    CHANGELOG.md
+
+source-repository head
+  type: git
+  location: https://github.com/githubuser/logger-example
+
+library
+  exposed-modules:
+      Lib
+  other-modules:
+      Paths_logger_example
+  autogen-modules:
+      Paths_logger_example
+  hs-source-dirs:
+      src
+  ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+  build-depends:
+      atomic-write >=0.2
+    , base >=4.7 && <5
+    , filepath >=1.4 && <2
+    , text >=2.0
+  default-language: Haskell2010
+
+executable logger-example-exe
+  main-is: Main.hs
+  other-modules:
+      Paths_logger_example
+  autogen-modules:
+      Paths_logger_example
+  hs-source-dirs:
+      app
+  ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      atomic-write >=0.2
+    , base >=4.7 && <5
+    , filepath >=1.4 && <2
+    , logger-example
+    , text >=2.0
+  default-language: Haskell2010
+
+test-suite logger-example-test
+  type: exitcode-stdio-1.0
+  main-is: Spec.hs
+  other-modules:
+      Paths_logger_example
+  autogen-modules:
+      Paths_logger_example
+  hs-source-dirs:
+      test
+  ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      atomic-write >=0.2
+    , base >=4.7 && <5
+    , filepath >=1.4 && <2
+    , logger-example
+    , text >=2.0
+  default-language: Haskell2010

examples/logger/package.yaml

@@ -0,0 +1,62 @@
+name:                logger-example
+version:             0.1.0.0
+github:              "stackbuilders/atomic-write"
+license:             BSD-3-Clause
+author:              "@BarbDMC"
+maintainer:          "[email protected]"
+copyright:           "2023 @BarbDMC"
+
+extra-source-files:
+- README.md
+- CHANGELOG.md
+
+# Metadata used when publishing your package
+# synopsis:            Short description of your package
+# category:            Web
+
+# To avoid duplicated efforts in documentation and dealing with the
+# complications of embedding Haddock markup inside cabal files, it is
+# common to point users to the README.md file.
+description:         Please see the README on GitHub at <https://github.com/githubuser/logger-example#readme>
+
+dependencies:
+- base >= 4.7 && < 5
+- atomic-write >= 0.2
+- text >= 2.0
+- filepath >= 1.4 && < 2
+
+ghc-options:
+- -Wall
+- -Wcompat
+- -Widentities
+- -Wincomplete-record-updates
+- -Wincomplete-uni-patterns
+- -Wmissing-export-lists
+- -Wmissing-home-modules
+- -Wpartial-fields
+- -Wredundant-constraints
+
+library:
+  source-dirs: src
+
+executables:
+  logger-example-exe:
+    main:                Main.hs
+    source-dirs:         app
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - logger-example
+
+tests:
+  logger-example-test:
+    main:                Spec.hs
+    source-dirs:         test
+    ghc-options:
+    - -threaded
+    - -rtsopts
+    - -with-rtsopts=-N
+    dependencies:
+    - logger-example

examples/logger/src/Lib.hs

@@ -0,0 +1,6 @@
+module Lib
+    ( someFunc
+    ) where
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"

examples/logger/stack.yaml

@@ -0,0 +1,67 @@
+# This file was automatically generated by 'stack init'
+#
+# Some commonly used options have been documented as comments in this file.
+# For advanced use and comprehensive documentation of the format, please see:
+# https://docs.haskellstack.org/en/stable/yaml_configuration/
+
+# Resolver to choose a 'specific' stackage snapshot or a compiler version.
+# A snapshot resolver dictates the compiler version and the set of packages
+# to be used for project dependencies. For example:
+#
+# resolver: lts-21.13
+# resolver: nightly-2023-09-24
+# resolver: ghc-9.6.2
+#
+# The location of a snapshot can be provided as a file or url. Stack assumes
+# a snapshot provided as a file might change, whereas a url resource does not.
+#
+# resolver: ./custom-snapshot.yaml
+# resolver: https://example.com/snapshots/2023-01-01.yaml
+resolver:
+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/19.yaml
+
+# User packages to be built.
+# Various formats can be used as shown in the example below.
+#
+# packages:
+# - some-directory
+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
+#   subdirs:
+#   - auto-update
+#   - wai
+packages:
+- .
+# Dependency packages to be pulled from upstream that are not in the resolver.
+# These entries can reference officially published versions as well as
+# forks / in-progress versions pinned to a git hash. For example:
+#
+# extra-deps:
+# - acme-missiles-0.3
+# - git: https://github.com/commercialhaskell/stack.git
+#   commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
+#
+# extra-deps: []
+
+# Override default flag values for local packages and extra-deps
+# flags: {}
+
+# Extra package databases containing global packages
+# extra-package-dbs: []
+
+# Control whether we use the GHC we find on the path
+# system-ghc: true
+#
+# Require a specific version of Stack, using version ranges
+# require-stack-version: -any # Default
+# require-stack-version: ">=2.13"
+#
+# Override the architecture used by Stack, especially useful on Windows
+# arch: i386
+# arch: x86_64
+#
+# Extra directories used by Stack for building
+# extra-include-dirs: [/path/to/dir]
+# extra-lib-dirs: [/path/to/dir]
+#
+# Allow a newer minor version of GHC than the snapshot specifies
+# compiler-check: newer-minor

examples/logger/stack.yaml.lock

@@ -0,0 +1,13 @@
+# This file was autogenerated by Stack.
+# You should not edit this file by hand.
+# For more information, please see the documentation at:
+#   https://docs.haskellstack.org/en/stable/lock_files
+
+packages: []
+snapshots:
+- completed:
+    sha256: fb482b8e2d5d061cdda4ba1da2957c012740c893a5ee1c1b99001adae7b1fbe7
+    size: 640046
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/19.yaml
+  original:
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/19.yaml